Cutlery/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-11-04 03:27:12 -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
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/administration.md
View File

@ -81,8 +81,8 @@ $ docker compose down
1. If you pull the image from the docker hub, all you need to do is: 1. If you pull the image from the docker hub, all you need to do is:
```shell-session ```shell-session
$ docker compose pull docker compose pull
$ docker compose up docker compose up
``` ```
The Docker Compose files refer to the `latest` version, which is The Docker Compose files refer to the `latest` version, which is
@ -91,9 +91,9 @@ $ docker compose down
1. If you built the image yourself, do the following: 1. If you built the image yourself, do the following:
```shell-session ```shell-session
$ git pull git pull
$ docker compose build docker compose build
$ docker compose up docker compose up
``` ```
Running `docker compose up` will also apply any new database migrations. Running `docker compose up` will also apply any new database migrations.
@ -155,7 +155,7 @@ following:
environment before that, if you use one. environment before that, if you use one.
```shell-session ```shell-session
$ pip install -r requirements.txt pip install -r requirements.txt
``` ```
!!! note !!! note
@ -168,8 +168,8 @@ following:
3. Migrate the database. 3. Migrate the database.
```shell-session ```shell-session
$ cd src cd src
$ python3 manage.py migrate # (1) python3 manage.py migrate # (1)
``` ```
1. Including `sudo -Hu <paperless_user>` may be required 1. Including `sudo -Hu <paperless_user>` may be required

4
docs/configuration.md
View File

@ -1519,7 +1519,7 @@ one pod).
actual user ID on the host system, which you can get by executing actual user ID on the host system, which you can get by executing
``` shell-session ``` shell-session
$ id -u id -u
``` ```
Paperless will change ownership on its folders to this user, so you Paperless will change ownership on its folders to this user, so you
@ -1534,7 +1534,7 @@ actual user ID on the host system, which you can get by executing
actual group ID on the host system, which you can get by executing actual group ID on the host system, which you can get by executing
``` shell-session ``` shell-session
$ id -g id -g
``` ```
Paperless will change ownership on its folders to this group, so you Paperless will change ownership on its folders to this group, so you

24
docs/development.md
View File

@ -69,13 +69,13 @@ first-time setup.
3. Create `consume` and `media` directories: 3. Create `consume` and `media` directories:
```bash ```bash
$ mkdir -p consume media mkdir -p consume media
``` ```
4. Install the Python dependencies: 4. Install the Python dependencies:
```bash ```bash
$ pipenv install --dev pipenv install --dev
``` ```
!!! note !!! note
@ -85,7 +85,7 @@ first-time setup.
5. Install pre-commit hooks: 5. Install pre-commit hooks:
```bash ```bash
$ pre-commit install pre-commit install
``` ```
6. Apply migrations and create a superuser for your development instance: 6. Apply migrations and create a superuser for your development instance:
@ -93,8 +93,8 @@ first-time setup.
```bash ```bash
# src/ # src/
$ python3 manage.py migrate python3 manage.py migrate
$ python3 manage.py createsuperuser python3 manage.py createsuperuser
``` ```
7. You can now either ... 7. You can now either ...
@ -108,7 +108,7 @@ first-time setup.
- spin up a bare redis container - spin up a bare redis container
``` ```
$ docker run -d -p 6379:6379 --restart unless-stopped redis:latest docker run -d -p 6379:6379 --restart unless-stopped redis:latest
``` ```
8. Continue with either back-end or front-end development – or both :-). 8. Continue with either back-end or front-end development – or both :-).
@ -176,7 +176,7 @@ The front end is built using AngularJS. In order to get started, you need Node.j
1. Install the Angular CLI. You might need sudo privileges to perform this command: 1. Install the Angular CLI. You might need sudo privileges to perform this command:
```bash ```bash
$ npm install -g @angular/cli npm install -g @angular/cli
``` ```
2. Make sure that it's on your path. 2. Make sure that it's on your path.
@ -184,13 +184,13 @@ The front end is built using AngularJS. In order to get started, you need Node.j
3. Install all necessary modules: 3. Install all necessary modules:
```bash ```bash
$ npm install npm install
``` ```
4. You can launch a development server by running: 4. You can launch a development server by running:
```bash ```bash
$ ng serve ng serve
``` ```
This will automatically update whenever you save. However, in-place This will automatically update whenever you save. However, in-place
@ -335,13 +335,13 @@ If you want to build the documentation locally, this is how you do it:
1. Have an active pipenv shell (`pipenv shell`) and install Python dependencies: 1. Have an active pipenv shell (`pipenv shell`) and install Python dependencies:
```bash ```bash
$ pipenv install --dev pipenv install --dev
``` ```
2. Build the documentation 2. Build the documentation
```bash ```bash
$ mkdocs build --config-file mkdocs.yml mkdocs build --config-file mkdocs.yml
``` ```
_alternatively..._ _alternatively..._
@ -352,7 +352,7 @@ If you want to build the documentation locally, this is how you do it:
something. something.
```bash ```bash
$ mkdocs serve mkdocs serve
``` ```
## Building the Docker image ## Building the Docker image

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: 2. Download and run the installation script:
```shell-session ```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 !!! note
@ -49,7 +49,7 @@ steps described in [Docker setup](#docker_hub) automatically.
configuration files and consumption directory. configuration files and consumption directory.
```shell-session ```shell-session
$ mkdir -v ~/paperless-ngx mkdir -v ~/paperless-ngx
``` ```
2. Go to the [/docker/compose directory on the project 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: execute the following command:
```shell-session ```shell-session
$ docker compose run --rm webserver createsuperuser docker compose run --rm webserver createsuperuser
``` ```
or using docker exec from within the container: or using docker exec from within the container:
```shell-session ```shell-session
$ python3 manage.py createsuperuser python3 manage.py createsuperuser
``` ```
This will prompt you to set a username, an optional e-mail address 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 `docker compose pull` to pull the image, do
```shell-session ```shell-session
$ docker compose build docker compose build
``` ```
instead to build the image. instead to build the image.
@ -607,8 +607,8 @@ Migration to paperless-ngx is then performed in a few simple steps:
1. Stop paperless. 1. Stop paperless.
```bash ```bash
$ cd /path/to/current/paperless cd /path/to/current/paperless
$ docker compose down docker compose down
``` ```
2. Do a backup for two purposes: If something goes wrong, you still 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 names of your volumes with
``` shell-session ``` 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 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: the search index:
```shell-session ```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 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. 8. Start paperless-ngx.
```bash ```bash
$ docker compose up -d docker compose up -d
``` ```
This will run paperless in the background and automatically start it This will run paperless in the background and automatically start it

2
docs/troubleshooting.md
View File

@ -18,7 +18,7 @@ Check for the following issues:
automatically. Manually invoke the task processor by executing automatically. Manually invoke the task processor by executing
```shell-session ```shell-session
$ celery --app paperless worker celery --app paperless worker
``` ```
- Look at the output of paperless and inspect it for any errors. - Look at the output of paperless and inspect it for any errors.

8
docs/usage.md
View File

@ -788,8 +788,8 @@ Paperless-ngx consists of the following components:
with paperless. You may start the webserver directly with with paperless. You may start the webserver directly with
```shell-session ```shell-session
$ cd /path/to/paperless/src/ cd /path/to/paperless/src/
$ gunicorn -c ../gunicorn.conf.py paperless.wsgi gunicorn -c ../gunicorn.conf.py paperless.wsgi
``` ```
or by any other means such as Apache `mod_wsgi`. or by any other means such as Apache `mod_wsgi`.
@ -804,8 +804,8 @@ Paperless-ngx consists of the following components:
Start the consumer with the management command `document_consumer`: Start the consumer with the management command `document_consumer`:
```shell-session ```shell-session
$ cd /path/to/paperless/src/ cd /path/to/paperless/src/
$ python3 manage.py document_consumer python3 manage.py document_consumer
``` ```
- **The task processor:** Paperless relies on [Celery - Distributed - **The task processor:** Paperless relies on [Celery - Distributed