Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change bash to shell in docs codeblocks #880

Merged
merged 1 commit into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/developers/development_environment/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Viseron requires a lot of dependencies.
To make testing with `pytest` as easy as possible, `tox` will build and run a Docker container which executes `pytest`.
If you would like to run tests outside of `tox` you can build and run this container manually:

```bash
```shell
docker compose --file azure-pipelines/docker-compose-build.yaml --env-file azure-pipelines/.env build amd64-viseron-tests
docker compose --file azure-pipelines/docker-compose-build.yaml --env-file azure-pipelines/.env run --rm amd64-viseron-tests
```
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ You can use `pre-commit` to run the Python linters manually.

To run all linters:

```bash
```shell
pre-commit run --all-files
```

To single out a specific linter (e.g. `pylint`):

```bash
```shell
pre-commit run pylint --all-files
```

Expand All @@ -64,13 +64,13 @@ You can use `npm` to run the TypeScript linters manually.

To run all linters:

```bash
```shell
npm run lint
```

To single out a specific linter (e.g. `prettier`):

```bash
```shell
npm run lint:prettier
```

Expand Down
16 changes: 8 additions & 8 deletions docs/docs/developers/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Viseron heavily uses multistage Docker builds, and compilation of different comp

If you have made changes to the Viseron code and want to rebuild the image, you can run the following command.

```bash
```shell
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-viseron
```

Expand All @@ -30,11 +30,11 @@ If your changes requires a new or updated Python dependency, you have to rebuild

- Edit `requirements.txt` in the root of the repository (preferably by pinning the version of the dependency).
- Build the wheels image:
```bash
```shell
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-wheels
```
- Build Viseron image:
```bash
```shell
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-viseron
```

Expand All @@ -45,19 +45,19 @@ To do this you would:

- Edit `OPENCV_VERSION` in ./azure-pipelines/.env
- Build the OpenCV image:
```bash
```shell
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-opencv
```
- Build Viseron image:
```bash
```shell
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-viseron
```

### Rebuild all images

To build all the `amd64` image from scratch the following commands can be used.

```bash
```shell
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-ffmpeg && \
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-opencv && \
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build amd64-dlib && \
Expand All @@ -73,13 +73,13 @@ To build these you need to first register QEMU on your builder.

The easiest way to do that is to run:

```bash
```shell
docker run --rm --privileged tonistiigi/binfmt --install all
```

You can then simply build the containers like you normally would and QEMU will be invoked automatically.

```bash
```shell
docker compose --file ./azure-pipelines/docker-compose-build.yaml --env ./azure-pipelines/.env build aarch64-viseron
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/documentation/configuration/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This will be added in a future release.

If you forget your password, you can reset it by deleting these files:

```bash
```shell
/config/.viseron/onboarding
/config/.viseron/auth
```
Expand Down
14 changes: 7 additions & 7 deletions docs/docs/documentation/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You have to change the values between the brackets `{}` to match your setup.
<Tabs groupId="docker-type">
<TabItem value="docker" label="Docker">

```bash
```shell
docker run --rm \
-v {recordings path}:/recordings \
-v {recordings path}:/segments \
Expand Down Expand Up @@ -95,7 +95,7 @@ services:
<Tabs groupId="docker-type">
<TabItem value="docker" label="Docker">

```bash
```shell
docker run --rm \
-v {recordings path}:/recordings \
-v {recordings path}:/segments \
Expand Down Expand Up @@ -144,7 +144,7 @@ services:
<Tabs groupId="docker-type">
<TabItem value="docker" label="Docker">

```bash
```shell
docker run --rm \
-v {recordings path}:/recordings \
-v {recordings path}:/segments \
Expand Down Expand Up @@ -199,7 +199,7 @@ Make sure [NVIDIA Container Toolkit](https://github.com/NVIDIA/nvidia-container-
<Tabs groupId="docker-type">
<TabItem value="docker" label="Docker">

```bash
```shell
docker run --rm \
-v {recordings path}:/recordings \
-v {recordings path}:/segments \
Expand Down Expand Up @@ -263,7 +263,7 @@ You can probably get around this by manually mounting all the needed devices but
<Tabs groupId="docker-type">
<TabItem value="docker" label="Docker">

```bash
```shell
docker run --rm \
--privileged \
-v {recordings path}:/recordings \
Expand Down Expand Up @@ -335,7 +335,7 @@ Configure a substream if you plan on running Viseron on an RPi.
<Tabs groupId="docker-type">
<TabItem value="docker" label="Docker">

```bash
```shell
docker run --rm \
--privileged \
-v {recordings path}:/recordings \
Expand Down Expand Up @@ -431,7 +431,7 @@ To solve this, you can specify the user `PUID` and group `PGID` as environment v
<details>
<summary>Docker command</summary>

```bash
```shell
docker run --rm \
-v {recordings path}:/recordings \
-v {recordings path}:/segments \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ ffmpeg:

And the resulting command looks like this:

```bash
```shell
ffmpeg -hide_banner -loglevel error -avoid_negative_ts make_zero -fflags nobuffer -flags low_delay -strict experimental -fflags +genpts -use_wallclock_as_timestamps 1 -vsync 0 -stimeout 5000000 -c:v h264_cuvid -rtsp_transport tcp -i rtsp://*****:*****@192.168.**.**:554/Streaming/Channels/101/ -vf transpose=2,transpose=2,fps=1.0 -f rawvideo -pix_fmt nv12 pipe:1
```

Expand Down Expand Up @@ -205,7 +205,7 @@ This will use more memory but reduce the load on your harddrives.

Example Docker command

```bash
```shell
docker run --rm \
-v {recordings path}:/recordings \
-v {recordings path}:/segments \
Expand Down
Loading