paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-07-28 18:24:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: remove dollar sign in code snippets (#8600)

Browse Source
This commit is contained in:
Malte Breitzmann
2025-01-04 01:30:25 +01:00
committed by GitHub
parent 8e6de2790e
commit 2a1c6bf0ca
6 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/setup.md
View File

@@ -35,7 +35,7 @@ steps described in [Docker setup](#docker_hub) automatically.
2. Download and run the installation script:
```shell-session
$ bash -c "$(curl --location --silent --show-error https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
bash -c "$(curl --location --silent --show-error https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
```
!!! note
@@ -49,7 +49,7 @@ steps described in [Docker setup](#docker_hub) automatically.
configuration files and consumption directory.
```shell-session
$ mkdir -v ~/paperless-ngx
mkdir -v ~/paperless-ngx
```
2. Go to the [/docker/compose directory on the project
@@ -180,13 +180,13 @@ steps described in [Docker setup](#docker_hub) automatically.
execute the following command:
```shell-session
$ docker compose run --rm webserver createsuperuser
docker compose run --rm webserver createsuperuser
```
or using docker exec from within the container:
```shell-session
$ python3 manage.py createsuperuser
python3 manage.py createsuperuser
```
This will prompt you to set a username, an optional e-mail address
@@ -238,7 +238,7 @@ steps described in [Docker setup](#docker_hub) automatically.
`docker compose pull` to pull the image, do
```shell-session
$ docker compose build
docker compose build
```
instead to build the image.
@@ -607,8 +607,8 @@ Migration to paperless-ngx is then performed in a few simple steps:
1. Stop paperless.
```bash
$ cd /path/to/current/paperless
$ docker compose down
cd /path/to/current/paperless
docker compose down
```
2. Do a backup for two purposes: If something goes wrong, you still
@@ -632,7 +632,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
names of your volumes with
``` shell-session
$ docker volume ls | grep _data
docker volume ls | grep _data
```
and adjust the project name in the `.env` file so that it matches
@@ -653,7 +653,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
the search index:
```shell-session
$ docker compose run --rm webserver document_index reindex
docker compose run --rm webserver document_index reindex
```
This will migrate your database and create the search index. After
@@ -662,7 +662,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
8. Start paperless-ngx.
```bash
$ docker compose up -d
docker compose up -d
```
This will run paperless in the background and automatically start it