mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-20 17:15:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added info on how to execute commands inside docker container to docs

Browse source
This commit is contained in:
Jan Böhmer 2024-01-28 18:30:16 +01:00
parent a161e3a520
commit 3548f12deb
1 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/usage/console_commands.md
View file

@ -8,11 +8,23 @@ parent: Usage
Part-DB provides some console commands to display various information or perform some tasks.
The commands are invoked from the main directory of Part-DB with the command `php bin/console [command]` in the context
of the database user (so usually the webserver user), so you maybe have to use `sudo` or `su` to execute the commands.
of the database user (so usually the webserver user), so you maybe have to use `sudo` or `su` to execute the commands:
```bash
sudo -u www-data php bin/console [command]
```
You can get help for every command with the parameter `--help`. See `php bin/console` for a list of all available
commands.
If you are running Part-DB in a docker container, you must either execute the commands from a shell inside a container,
or use the `docker exec` command to execute the command directly inside the container. For example if you docker container
is named `partdb`, you can execute the command `php bin/console cache:clear` with the following command:
```bash
docker exec --user=www-data partdb php bin/console cache:clear
```
## User management commands
* `php bin/console partdb:users:list`: List all users of this Part-DB instance