Adding info about Video files. Adding docs for multiple external usb drives.

This commit is contained in:
Roland 2024-03-10 16:41:56 -06:00
parent 356ec0364f
commit 7be4718bdd
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
16 changed files with 191 additions and 44 deletions

View file

@ -0,0 +1,45 @@
# External USB Drive Configuration
WROLPi expects a single USB drive to be mounted at `/media/wrolpi`. However, multiple drives are supported. WROLPi
uses special directories to know where to place downloaded files. The config special directories cannot be changed
and WROLPi will always look for it at `/media/wrolpi/config`
The default special directories are the following (the inputs are disabled because the "Edit Directories" toggle
is not checked):
![Special Directories Settings](special-directories-settings.png)
## 2+ drives
As of the writing of this article, WROLPi partially supports multiple drives. The _primary_ drive must be mounted to
`/media/wrolpi`, the configs will be written to this drive. The other drive must be mounted within `/media/wrolpi`.
If you wanted your _secondary_ drive named "secondary", you could mount it at `/media/wrolpi/secondary`. Linux will
ensure the files are placed in the correct drives.
### Migrating from one to two drives
Assuming that you have a WROLPi with a single external hard drive, and would like to add a second drive, follow these
steps.
1. Mount the _secondary_ drive to some path in `/media/wrolpi`. We will assume you use `/media/wrolpi/secondary` for
this example. Follow this pattern for all new drives.
1. `mkdir /media/wrolpi/secondary`
2. `mount /dev/sdb1 /media/wrolpi/secondary`
2. Decide where WROLPi will download files.
1. WROLPi will download videos to `/media/wrolpi/videos` by default. If you want WROLPi to save new videos to
the secondary drive, edit the "Videos Directory" in `Admin > Settings > Special Directories` to something like
`secondary/videos`.
2. Do this for all special directories.
3. You can keep all special directories in the _primary_ drive, WROLPi will still search the _secondary_ drive for
any new files.
3. Make the drive mounts permanent by modifying `/etc/fstab`:
```
/dev/sda1 /media/wrolpi auto defaults,nofail 0 0 # primary
/dev/sdb /media/wrolpi/secondary auto defaults,nofail 0 0 # secondary
```
4. Verify that the mounts are correct by rebooting.
- `sudo reboot`
5. [Refresh your files](../modules/files/index.md#refreshing)

View file

@ -4,13 +4,15 @@
To finish your WROLPi installation follow these steps:
1. Modify fstab to mount your external drive. In the example below, `/dev/sda1` will be mounted to `/media/wrolpi`
1. Modify fstab to mount your external drive(s). In the example below, `/dev/sda1` will be mounted to `/media/wrolpi`
1. `echo '/dev/sda1 /media/wrolpi auto defaults,nofail 0 0' | sudo tee -a /etc/fstab`
2. Finish the installation with the repair script: `sudo bash /opt/wrolpi/repair.sh`
3. Reboot: `sudo reboot`
4. After reboot, browse to `http://wrolpi.local` or `http://127.0.0.1` on the WROLPi itself.
5. [Refresh your files](../modules/files/index.md#refreshing)
[Support for multiple drives](external-drives.md)
# Creating a new WROLPi
## Raspberry Pi

View file

@ -5,15 +5,21 @@ gathered by `systemd`. Logs are viewed using `journalctl`.
You can watch all the logs on your WROLPi:
`journalctl -f`
```shell
journalctl -f
```
More detailed logs can be viewed:
`journalctl -f -p debug`
```shell
journalctl -f -p debug
```
To view logs only from the most recent boot:
`journalctl -f -b`
```shell
journalctl -f -b
```
The above commands use `-f` (follow) which will display logs as soon as they are created. You can view older logs by
removing `-f` from the command, but you will need to use your keyboard to navigate the logs. Use `up`, `down`,
@ -24,22 +30,30 @@ the bottom of the logs.
To watch the API logs:
`journalctl -f -u wrolpi-api`
```shell
journalctl -f -u wrolpi-api
```
## React App
To watch the React App logs:
`journalctl -f -u wrolpi-app`
```shell
journalctl -f -u wrolpi-app
```
## Map
To watch the Map logs:
`journalctl -f -u renderd`
```shell
journalctl -f -u renderd
```
## Zim
To watch the React App logs:
`journalctl -f -u wrolpi-kiwix`
```shell
journalctl -f -u wrolpi-kiwix
```

View file

@ -3,10 +3,11 @@
WROLPi attempts to integrate all services in an easy to learn interface. But, if the React app is unavailable, secondary
and tertiary options to use your WROLPi may be available.
| Module | Primary | Secondary | Tertiary |
|----------|-----------|---------------------------------------------------------|-----------------------------------------------------|
| Videos | React App | Open video files with VLC. | Open subtitle files with a text editor. |
| Archives | React App | Open Archive files directly with Chromium | Readability files can be opened with a text editor. |
| Map | React App | Map is directly accessible on port `:8084` | None |
| Zim | React App | Kiwix server is directly accessible on port `:8085` | Kiwix application |
| Help | React App | Markdown files are available in `/opt/wrolpi-help/docs` | None |
| Module | Primary | Secondary | Tertiary |
|----------|-------------------------------------------|--------------------------------------------------------------------------------|-------------------------------------------------------------------|
| Videos | [React App](../modules/videos/index.md) | [Open video files with VLC.](../modules/videos/index.md#videos-without-wrolpi) | Open subtitle files with a text editor. |
| Archives | [React App](../modules/archives/index.md) | Open Archive files directly with Chromium | Readability files can be opened with a text editor. |
| Map | [React App](../modules/map/index.md) | Map is directly accessible on port `:8084` | None |
| Zim | [React App](../modules/zim/index.md) | Kiwix server is directly accessible on port `:8085` | [Kiwix application](../modules/zim/index.md#kiwix-without-wrolpi) |
| Help | [React App](../..) | Markdown files are available in `/opt/wrolpi-help/docs` | None |

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View file

@ -1,10 +1,12 @@
# Service Control
WROLPi services are controlled by `systemd`.
You can view and control the WROLPi services using these commands:
| Service | Status | Logs | Restart | Stop | Start |
|-----------|---------------------------------|---------------------------|----------------------------------|-------------------------------|--------------------------------|
| API | `systemctl status wrolpi-api` | `journalctl wrolpi-api` | `systemctl restart wrolpi-api` | `systemctl stop wrolpi-api` | `systemctl start wrolpi-api` |
| React App | `systemctl status wrolpi-app` | `journalctl wrolpi-app` | `systemctl restart wrolpi-app` | `systemctl stop wrolpi-app` | `systemctl start wrolpi-app` |
| Map | `systemctl status renderd` | `journalctl renderd` | `systemctl restart renderd` | `systemctl stop renderd` | `systemctl start renderd` |
| Zim | `systemctl status wrolpi-kiwix` | `journalctl wrolpi-kiwix` | `systemctl restart wrolpi-kiwix` | `systemctl stop wrolpi-kiwix` | `systemctl start wrolpi-kiwix` |
| Service | Status | Logs | Restart | Stop | Start |
|-----------|---------------------------------|------------------------------|----------------------------------|-------------------------------|--------------------------------|
| API | `systemctl status wrolpi-api` | `journalctl -u wrolpi-api` | `systemctl restart wrolpi-api` | `systemctl stop wrolpi-api` | `systemctl start wrolpi-api` |
| React App | `systemctl status wrolpi-app` | `journalctl -u wrolpi-app` | `systemctl restart wrolpi-app` | `systemctl stop wrolpi-app` | `systemctl start wrolpi-app` |
| Map | `systemctl status renderd` | `journalctl -u renderd` | `systemctl restart renderd` | `systemctl stop renderd` | `systemctl start renderd` |
| Zim | `systemctl status wrolpi-kiwix` | `journalctl -u wrolpi-kiwix` | `systemctl restart wrolpi-kiwix` | `systemctl stop wrolpi-kiwix` | `systemctl start wrolpi-kiwix` |