diff --git a/docker/compose/docker-compose.mariadb-tika.yml b/docker/compose/docker-compose.mariadb-tika.yml index 73f30da78..434c72b0a 100644 --- a/docker/compose/docker-compose.mariadb-tika.yml +++ b/docker/compose/docker-compose.mariadb-tika.yml @@ -24,8 +24,10 @@ # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env' # and '.env' into a folder. # - Run 'docker compose pull'. -# - Run 'docker compose run --rm webserver ./manage.py createsuperuser' to create a user. # - Run 'docker compose up -d'. +# - Wait until the webserver has completed startup +# - Run 'docker compose exec webserver ./manage.py createsuperuser' to create a user. + # # For more extensive installation and update instructions, refer to the # documentation. diff --git a/docker/compose/docker-compose.mariadb.yml b/docker/compose/docker-compose.mariadb.yml index 2a00a0be6..9a32368d4 100644 --- a/docker/compose/docker-compose.mariadb.yml +++ b/docker/compose/docker-compose.mariadb.yml @@ -20,8 +20,9 @@ # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env' # and '.env' into a folder. # - Run 'docker compose pull'. -# - Run 'docker compose run --rm webserver ./manage.py createsuperuser' to create a user. # - Run 'docker compose up -d'. +# - Wait until the webserver has completed startup +# - Run 'docker compose exec webserver ./manage.py createsuperuser' to create a user. # # For more extensive installation and update instructions, refer to the # documentation. diff --git a/docker/compose/docker-compose.portainer.yml b/docker/compose/docker-compose.portainer.yml index f655131eb..a9eb436bf 100644 --- a/docker/compose/docker-compose.portainer.yml +++ b/docker/compose/docker-compose.portainer.yml @@ -24,7 +24,7 @@ # - Click 'Deploy the stack' and wait for it to be deployed # - Open the list of containers, select paperless_webserver_1 # - Click 'Console' and then 'Connect' to open the command line inside the container -# - Run 'python3 manage.py ./manage.py createsuperuser' to create a user +# - Run './manage.py createsuperuser' to create a user # - Exit the console # # For more extensive installation and update instructions, refer to the diff --git a/docker/compose/docker-compose.postgres-tika.yml b/docker/compose/docker-compose.postgres-tika.yml index fdd794275..6c0803337 100644 --- a/docker/compose/docker-compose.postgres-tika.yml +++ b/docker/compose/docker-compose.postgres-tika.yml @@ -24,8 +24,9 @@ # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env' # and '.env' into a folder. # - Run 'docker compose pull'. -# - Run 'docker compose run --rm webserver ./manage.py createsuperuser' to create a user. # - Run 'docker compose up -d'. +# - Wait until the webserver has completed startup +# - Run 'docker compose exec webserver ./manage.py createsuperuser' to create a user. # # For more extensive installation and update instructions, refer to the # documentation. diff --git a/docker/compose/docker-compose.postgres.yml b/docker/compose/docker-compose.postgres.yml index eeb9ddfa2..fcf6c322b 100644 --- a/docker/compose/docker-compose.postgres.yml +++ b/docker/compose/docker-compose.postgres.yml @@ -20,8 +20,9 @@ # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env' # and '.env' into a folder. # - Run 'docker compose pull'. -# - Run 'docker compose run --rm webserver ./manage.py createsuperuser' to create a user. # - Run 'docker compose up -d'. +# - Wait until the webserver has completed startup +# - Run 'docker compose exec webserver ./manage.py createsuperuser' to create a user. # # For more extensive installation and update instructions, refer to the # documentation. diff --git a/docker/compose/docker-compose.sqlite-tika.yml b/docker/compose/docker-compose.sqlite-tika.yml index a6340b166..a096793a3 100644 --- a/docker/compose/docker-compose.sqlite-tika.yml +++ b/docker/compose/docker-compose.sqlite-tika.yml @@ -24,8 +24,9 @@ # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env' # and '.env' into a folder. # - Run 'docker compose pull'. -# - Run 'docker compose run --rm webserver ./manage.py createsuperuser' to create a user. # - Run 'docker compose up -d'. +# - Wait until the webserver has completed startup +# - Run 'docker compose exec webserver ./manage.py createsuperuser' to create a user. # # For more extensive installation and update instructions, refer to the # documentation. diff --git a/docker/compose/docker-compose.sqlite.yml b/docker/compose/docker-compose.sqlite.yml index 92c126bca..1a9fd1a03 100644 --- a/docker/compose/docker-compose.sqlite.yml +++ b/docker/compose/docker-compose.sqlite.yml @@ -17,8 +17,9 @@ # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env' # and '.env' into a folder. # - Run 'docker compose pull'. -# - Run 'docker compose run --rm webserver ./manage.py createsuperuser' to create a user. # - Run 'docker compose up -d'. +# - Wait until the webserver has completed startup +# - Run 'docker compose exec webserver ./manage.py createsuperuser' to create a user. # # For more extensive installation and update instructions, refer to the # documentation. diff --git a/docs/setup.md b/docs/setup.md index d3f43aca7..6190b79fd 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -131,24 +131,30 @@ account. The script essentially automatically performs the steps described in [D by default but you can change the image to pull from Docker Hub by changing the `image` line to `image: paperlessngx/paperless-ngx:latest`. -6. To be able to login, you will need a "superuser". To create it, +6. Run `docker compose up -d`. This will create and start the necessary containers. + +7. Wait for the containers to complete their startup. You can monitor the logs using Docker, such as: + + ```shell-session + docker logs --follow webserver + ``` + +8. To be able to login, you will need a "superuser". To create it, execute the following command: ```shell-session - docker compose run --rm webserver ./manage.py createsuperuser + docker compose exec webserver ./manage.py createsuperuser ``` or using docker exec from within the container: ```shell-session - python3 manage.py createsuperuser + ./manage.py createsuperuser ``` This will guide you through the superuser setup. -7. Run `docker compose up -d`. This will create and start the necessary containers. - -8. Congratulations! Your Paperless-ngx instance should now be accessible at `http://127.0.0.1:8000` +9. Congratulations! Your Paperless-ngx instance should now be accessible at `http://127.0.0.1:8000` (or similar, depending on your configuration). Use the superuser credentials you have created in the previous step to login.