drinks-manager/docs/Commands.md

81 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

# Commands
You run a command with
```
./run.sh <command>
```
## Available Commands
---
### `server`
This starts the application (a caddy instance, uvicorn with the Django application and a scheduler that automatically removes expired session data).
Log files will be written.
---
### `setup`
This sets up some database tables, views, and more, generates a secret key for the application and lets you create an admin user.
---
### `create-admin`
Lets you create an admin user
---
### `generate-secret-key`
Generate a new random secret key for Django.
This will overwrite the old one.
Warning: After running this, current sessions will be invalid, and the users have to relogin. Don't run this command while the server is running.
---
### `clear-sessions`
manually remove all expired sessions from the database
---
### `force-db-upgrade`
force a database migration and -upgrade.
This is mainly used in development.
---
### `archive-tables`
archive (copy & delete) all entries in app_order and app_registertransaction.
Use this to archive old orders or transactions (e.g. when the database gets too big).
---
### `development-server`
This starts a caddy instance, the Django development server with DEBUGGING enabled and the session-clear-scheduler.
Only the HTTP-Access-Log will be written to its logfile, other logs will be written to the console.
---
### `shell`
Start a Django shell.
---
### `help`
Show a help text
---
## Examples
Run the production server:
```
./run.sh server
```
Create a new admin:
```
./run.sh create-admin
```