rt/wrolpi-help
1
0
Fork 0
mirror of https://github.com/wrolpi/wrolpi-help.git synced 2026-10-25 18:40:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding docs for Tags Directory.

Browse source
This commit is contained in:
Roland 2024-07-31 11:58:37 -06:00
parent 36565bcfaa
commit 6a6bde6752
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
2 changed files with 24 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/system/primary-secondary-tertiary.md
View file

@ -10,3 +10,4 @@ and tertiary options to use your WROLPi may be available.
| 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 | Help server is directly accessible on port `:8086` | Markdown files are available in `/opt/wrolpi-help/docs` |
| Tags | React App | Browse the Tags Directory: `/media/wrolpi/tags` | Read the config: `/media/wrolpi/config/tags.yaml` |

36
docs/system/special-directories.md
View file

@ -1,12 +1,13 @@
# Special System Directories
| Path | Purpose |
|-------------------------|----------------------------------------------------------|
| `/media/wrolpi/` | The [Media Directory](#media-directory). |
| `/opt/wrolpi/` | The [source code](#wrolpi-source-directory) of WROLPi. |
| `/media/wrolpi/config/` | The [configuration files](#wrolpi-config) of the WROLPi. |
| `/opt/wrolpi-blobs/` | Contains files necessary to repair a WROLPi. |
| `/opt/wrolpi-help/` | These help files. |
| Path | Purpose |
|-------------------------|--------------------------------------------------------------------------------------|
| `/media/wrolpi/` | The [Media Directory](#media-directory). |
| `/media/wrolpi/config/` | The [configuration files](#wrolpi-config) of the WROLPi. |
| `/media/wrolpi/tags/` | The [Tags Directory](#tags-directory) contains links to files that have been tagged. |
| `/opt/wrolpi-blobs/` | Contains files necessary to repair a WROLPi. |
| `/opt/wrolpi-help/` | These help files. |
| `/opt/wrolpi/` | The [source code](#wrolpi-source-directory) of WROLPi. |
## Media Directory
@ -17,12 +18,6 @@ files that are downloaded by WROLPi will be saved within this directory.
The normal media directory is `/media/wrolpi`
## WROLPi Source Directory
`/opt/wrolpi/`
This directory contains the source code of the WROLPi API, app, etc.
## WROLPi Config
`/media/wrolpi/config/`
@ -30,6 +25,15 @@ This directory contains the source code of the WROLPi API, app, etc.
This directory contains the configuration files of the WROLPi. These files are considered the "source of truth" and
their contents will alter the behavior of the WROLPi.
## Tags Directory
`/media/wrolpi/tags`
This directory contains links to tagged files. It is automatically managed by WROLPi as you add or remove tags from
files.
**Warning!** Do not store files in this directory, they will be automatically deleted.
## WROLPi Blobs
`/opt/wrolpi-blobs/`
@ -42,3 +46,9 @@ Postgresql dump of the map database. **It is best to leave this directory as-is
`/opt/wrolpi-help/`
This help file you are reading is contained in this directory.
## WROLPi Source Directory
`/opt/wrolpi/`
This directory contains the source code of the WROLPi API, app, etc.