ereuse
/
devicehub-django
8
0
Fork 0
Code Issues 5 Pull Requests 2 Packages Projects Releases Wiki Activity

README: small changes

This commit is contained in:
pedro 2024-11-08 15:50:36 +01:00
parent 4b953610fb
commit 4e1f62c5f6
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -19,16 +19,22 @@ 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
```
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
### Prerequisites
@ -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).