From d136ae3aa30b05e34b46e2136b34aa8e3c6a72ef Mon Sep 17 00:00:00 2001 From: pedro Date: Fri, 8 Nov 2024 15:50:36 +0100 Subject: [PATCH] README: small changes --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a919c4d..6a39255 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,21 @@ DeviceHub primarily works with three types of objects: ## Installation +Assuming a host with debian stable + ### Quickstart -For a quick start with dummy data, DeviceHub can be run directly with docker. To do so, from the root of the project run: +For a quick start with dummy data in localhost, DeviceHub can be run directly with docker. To do so, from the root of the project run: ```bash ./docker-reset.sh ``` -Also there is a demo running in http://demo.ereuse.org/. The token for accessing the instance will be always: `token=5018dd65-9abd-4a62-8896-80f34ac66150`, but the instance will be reset every day a t 4 am. +Note that everytime you perform the `docker-reset.sh` script, all data is lost. + +Also there is a demo running in http://demo.ereuse.org/. The token for accessing the instance will be always: `token=5018dd65-9abd-4a62-8896-80f34ac66150`, but the instance will be reset every day at 4 am. + +For production needs, review and change .env file properly ## Running from baremetal @@ -73,7 +79,7 @@ DOMAIN=localhost DEBUG=True ``` -Now, expand the enviroment variables: +Now, expand the environment variables: ```bash source .env @@ -104,7 +110,7 @@ Finally, we can run the DeviceHub service by running: python manage.py runserver ``` -## Clean up +### Clean up To clean up the deployment and start fresh, just delete Django's database: @@ -112,7 +118,6 @@ To clean up the deployment and start fresh, just delete Django's database: rm db/* ``` - ## License DeviceHub is released under the [GNU Affero General Public License v3.0](LICENSE).