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

Release week 22 #1006

Merged
merged 5 commits into from
Jun 1, 2024
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
25 changes: 7 additions & 18 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,17 @@ on: [pull_request, push]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions: { contents: read }
jobs:
main:
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
# https://github.com/actions/runner-images
runs-on: ubuntu-22.04
defaults:
run:
shell: sh
runs-on: ubuntu-24.04
steps:
- name: Setup tmpfs
run: sudo mount -t tmpfs -o "noatime,lazytime,uid=$(id -u)" tmpfs "$GITHUB_WORKSPACE"
- name: Clone DietPi-Docs repository
id: clone
# https://github.com/actions/checkout/tags
uses: actions/checkout@v4
- name: Setup Node.js for markdownlint-cli2
# https://github.com/actions/setup-node/tags
uses: actions/setup-node@v4
with:
node-version: '*'
Expand All @@ -31,11 +25,10 @@ jobs:
- name: Setup Python for MkDocs and PySpelling
id: python
if: always() && steps.clone.outcome == 'success'
# https://github.com/actions/setup-python/tags
uses: actions/setup-python@v5
with:
# Match version on dietpi.com server
python-version: '3.11.2'
python-version: '3.11.9'
- name: Install MkDocs
id: mkdocs
if: always() && steps.python.outcome == 'success'
Expand Down Expand Up @@ -68,13 +61,9 @@ jobs:
# "429 Too Many Requests" on GitHub despite token
# Exclude URLs for newly added Markdown files as well as raw view and edit GitHub URLs for all existing Markdown files
# parallels.com|chromewebstore.google.com: Cloudflare lets client enter redirect loop, if it does not send a cookie, set in response.
# raspberrypi.com|www.reddit.com|superuser.com: Network error: Forbidden
# raspberrypi.com|www.reddit.com|superuser.com|twitter.com/DietPi_|www.patreon.com/DietPi: Network error: Forbidden
run: |
git fetch --depth=1 origin master
while read -r line; do exclude="$exclude|dietpi.com/${line%.md}/"; done << _EOF_
$(git diff --name-only --diff-filter=A origin/master docs | grep '.md$')
_EOF_
while read -r line; do exclude="$exclude|github.com/MichaIng/DietPi-Docs/(raw|edit)/dev/$line"; done << _EOF_
$(find docs -type f -name '*.md')
_EOF_
./lychee -En --require-https --cache --exclude '^(http://wiringpi.com/$|https://(twitter.com/DietPi_$|www.linux-kvm.org/$|pydio.com/|www.spigotmc.org/|help.realvnc.com/|help.roonlabs.com/|blynk.io/|play.google.com/store/apps/details|www.kickstarter.com|theunarchiver.com/$|www.parallels.com/|(www|forums).raspberrypi.com/|www.reddit.com/|superuser.com|chromewebstore.google.com'"$exclude"'))' -a 429 --github-token '${{ secrets.GITHUB_TOKEN }}' -b build README.md 'build/**/*.html'
while read -r line; do exclude="$exclude|dietpi.com/${line%.md}/"; done < <(git diff --name-only --diff-filter=A origin/master docs | grep '.md$')
while read -r line; do exclude="$exclude|github.com/MichaIng/DietPi-Docs/(raw|edit)/dev/$line"; done < <(find docs -type f -name '*.md')
./lychee -En --require-https --cache --exclude '^(http://wiringpi.com/$|https://(twitter.com/DietPi_$|www.patreon.com/DietPi$|www.linux-kvm.org/$|pydio.com/|www.spigotmc.org/|help.realvnc.com/|help.roonlabs.com/|blynk.io/|play.google.com/store/apps/details|www.kickstarter.com|theunarchiver.com/$|www.parallels.com/|(www|forums).raspberrypi.com/|www.reddit.com/|superuser.com|chromewebstore.google.com'"$exclude"'))' -a 429 --github-token '${{ secrets.GITHUB_TOKEN }}' -b build README.md 'build/**/*.html'
6 changes: 0 additions & 6 deletions docs/hardware.md
Original file line number Diff line number Diff line change
Expand Up @@ -593,12 +593,6 @@ For more details visit the [**Orange Pi**](http://www.orangepi.org/index.html) w
<strong>Download</strong>: <a href="https://dietpi.com/downloads/images/DietPi_OrangePiZero3-ARMv8-Bookworm.img.xz">DietPi image</a>
</td>
</tr>
<tr>
<td><a class="table" href=""><strong>Orange Pi Zero 3 (1.5 GB RAM)</strong></a></td>
<td>
<strong>Download</strong>: <a href="https://dietpi.com/downloads/images/DietPi_OrangePiZero3-1.5G-ARMv8-Bookworm.img.xz">DietPi image</a>
</td>
</tr>
<tr>
<td><a class="table" href=""><strong>Orange Pi 3B</strong></a></td>
<td>
Expand Down
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ Select the following tabs for the installation description of your target.

Remember the VM ID, you need it later.

1. Tab **OS**: Select "**Do not use any media** ", for the **Guest OS** assure that **Linux** and version "**5.x - 2.6 Kernel**" is selected, then click **Next**.
1. Tab **OS**: Select "**Do not use any media** ", for the **Guest OS** assure that **Linux** and version "**6.x - 2.6 Kernel**" is selected, then click **Next**.
1. Tab **System**: As **Machine** you can select `q35`, but the older default will work as well. We recommend the para-virtualised **VirtIO SCSI** controller, which should be the default. Click **Next**.
1. Tab **Disks**: Delete the default `scsi0` disk with the red trash bin button, then click **Next**.
1. Tab **CPU**: Adjust CPU details as required, we recommend to use the default `kvm64` type. Then click **Next**.
Expand Down
2 changes: 1 addition & 1 deletion docs/software/camera.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ It consists of full control of the camera in a web-based interface.
=== "Access recordings (w/o web interface)"

To access you recordings remotely without the web interface, you might want to have one of [DietPi's file servers](file_servers.md) installed.
Directories used by motionEye:
Directories used by RPi Cam Web Interface:

- Media directory = `/mnt/dietpi_userdata/rpicam`
- Accessed from file server = `/rpicam`
Expand Down
2 changes: 1 addition & 1 deletion docs/software/gaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ PaperMC by default runs a single server, available on LAN, but can be port forwa

***

Official website: <https://paper.readthedocs.io>
Official website: <https://docs.papermc.io/paper/admin>
Source code: <https://github.com/PaperMC/Paper>

## Box86
Expand Down
44 changes: 44 additions & 0 deletions docs/software/programming.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,50 @@ _Source: [User:`Maklaan` - Based on a Docker blog post](https://commons.wikimedi
journalctl -u docker -u containerd
```

=== "Plugins"

Docker offers plugins on its website (e.g. [Docker Plugins amd64 stable](https://download.docker.com/linux/debian/dists/bookworm/pool/stable/amd64/){: class="nospellcheck"}), some of them are not installed by the Docker installation by default resp. are no install option from `dietpi-software` (like the Docker Compose plugin is one).
These additional plugins can be installed by the user as described below.

[Docker Buildx](https://docs.docker.com/build/architecture/){: class="nospellcheck"} CLI plugin:

```sh
apt install docker-buildx-plugin
```

[Docker vulnerability scan](https://docs.docker.com/docker-hub/vulnerability-scanning/) CLI plugin:

```sh
apt install docker-scan-plugin
```

For [running container rootless](https://docs.docker.com/engine/security/rootless/):

```sh
apt install docker-ce-rootless-extras
```

=== "Speed up image creation with a tmpfs"

Docker downloads image file chunks to `/mnt/dietpi_userdata/docker-data/tmp` when generating a Docker image. After this, the file chunks are deleted as they are only temporary files.
In case of a slower disk (e.g. SD Card) this takes a longer time due to the SD Card reading/writing speed. To speedup the image generation, a tmpfs file system can be used.
A drawback of using a tmpfs is the required RAM, i.e. enough RAM memory (e.g. > 2 GB) should be present for the tmpfs.

The tmpfs file system can be added manually via the file `/etc/fstab` by entering a line (e.g. in the `TMPFS` area) like:

```
tmpfs /mnt/dietpi_userdata/docker-data/tmp tmpfs size=2G,noatime,lazytime,nodev,nosuid
```

The `size=` option should be adjusted to the systems RAM size: Only a part of the total RAM size should be used to avoid low memory issues.
After changing the file `/etc/fstab` the tmpfs needs to be activated. This can be done via a file system remount via

```sh
mount -o remount /mnt/dietpi_userdata/docker-data/tmp
```

or a system reboot.

***

Official documentation: <https://docs.docker.com/get-started/overview/>
Expand Down
4 changes: 2 additions & 2 deletions docs/software/webserver_stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ The innovation of Nginx compared to earlier servers such as Apache was to use an

***

Official documentation: <https://www.nginx.com>
Official documentation: <https://docs.nginx.com/nginx/admin-guide/>

### Lighttpd

Expand Down Expand Up @@ -592,7 +592,7 @@ Official documentation: <https://nodejs.org/api/>
<!-- markdownlint-disable MD053 -->
[^1]: Find out more about the success stories of Nginx on: <https://nginx.org/en/>
[^3]: [Most Widely Deployed and Used Database Engine](https://www.sqlite.org/mostdeployed.html). Retrieved 12 December 2020
[^4]: [NGINX vs. Apache: Our View of a Decade-Old Question](https://www.nginx.com/blog/nginx-vs-apache-our-view/). Retrieved 12 December 2020
[^4]: [Apache vs Nginx: Practical Considerations](https://www.digitalocean.com/community/tutorials/apache-vs-nginx-practical-considerations). Retrieved 30 May 2024
[^5]: <https://hostingtribunal.com/blog/node-js-stats/#gref>. Retrieved 29 May 2021
[^6]: [CORS Errors Mozilla](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors). Retrieved 05 December 2021

Expand Down
Loading