diff --git a/docs/files/index.md b/docs/files/index.md index 8ca9b34..0b4fe35 100644 --- a/docs/files/index.md +++ b/docs/files/index.md @@ -15,7 +15,7 @@ WROLPi can search any file in your media directory, this can only be accomplishe completed. > To refresh all your files, click the **Files** link in the top navigation bar, then click **Refresh All** found at the -> bottom of the files page. +> bottom of the files table. ## Files Tools @@ -40,7 +40,6 @@ The tool buttons are as displayed: selected.) ## File Preview -
hello
When clicking on any file, WROLPi will attempt to provide you with a preview of the file. If no previewer has been created for the particular file type has been created, then the generic file preview will be used. diff --git a/docs/index.md b/docs/index.md index 5124bff..7cf8e67 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,3 +20,4 @@ This is the WROLPi help documentation. 1. Storage is cheaper than power. 2. Two is one, one is none. 3. Run silently. +4. [Primary, secondary, tertiary.](system/primary-secondary-tertiary.md) diff --git a/docs/map/index.md b/docs/map/index.md index e69de29..6035b2c 100644 --- a/docs/map/index.md +++ b/docs/map/index.md @@ -0,0 +1,28 @@ +# Map + +The Map module allows viewing, and importing of OpenStreetMap PBF files. The map is rendered live as you are using it. +Previously renderd tiles (images) are stored on root disk of the system which prevents re-rendering of tiles that have +been viewed previously. + +## Map + +The Map tab is a simple iframe around the Apache2 service on port `:8084` + +![Screenshot of the Map Viewer tab.](map-viewer.png) + +## Manage + +The files displayed in the Manage tab are those found in your media directory under `/map`. **Time To Import** is +estimated by running many tests importing PBF files on a Raspberry Pi 4. The larger the file, the more inaccurate the +time will be. + +> Select all map files you want to import, importing will erase any maps previously imported! + +![Manage Map Page](map-manage.png) + +### Downloading Map Files + +Map files are available for download from the Geofabrick company. You can download them using the **Files Downloader**, +save them to the `map` directory. After they have been downloaded, you will need to import them. + +![Downloading of a custom OSM PBF file.](pbf-file-downloader.png) \ No newline at end of file diff --git a/docs/map/map-manage.png b/docs/map/map-manage.png new file mode 100644 index 0000000..1228d00 Binary files /dev/null and b/docs/map/map-manage.png differ diff --git a/docs/map/map-viewer.png b/docs/map/map-viewer.png new file mode 100644 index 0000000..2e37aa2 Binary files /dev/null and b/docs/map/map-viewer.png differ diff --git a/docs/map/pbf-file-downloader.png b/docs/map/pbf-file-downloader.png new file mode 100644 index 0000000..dbd08a2 Binary files /dev/null and b/docs/map/pbf-file-downloader.png differ diff --git a/docs/other/ebooks.md b/docs/other/ebooks.md new file mode 100644 index 0000000..66532ba --- /dev/null +++ b/docs/other/ebooks.md @@ -0,0 +1,15 @@ +# eBooks + +eBooks are a secondary file type in WROLPi, which means that they do not yet have a dedicated module, and some features +may not yet be available. + +Epub files are desired as ebooks, though some support for Mobi files is provided. + +## Searching + +When indexes for an EPUB are generated, they are searched in the following order of precedence: + +1. Title +2. Author +3. Text +4. File path name \ No newline at end of file diff --git a/docs/other/pdfs.md b/docs/other/pdfs.md new file mode 100644 index 0000000..947c987 --- /dev/null +++ b/docs/other/pdfs.md @@ -0,0 +1,13 @@ +# PDF + +PDFs are a secondary file type in WROLPi, which means that they do not yet have a dedicated module, and some features +may not yet be available. + +## Searching + +When indexes for an PDFs are generated, they are searched in the following order of precedence: + +1. Title +2. Author +3. File path name +4. Text \ No newline at end of file diff --git a/docs/other/texts.md b/docs/other/texts.md new file mode 100644 index 0000000..3de3d15 --- /dev/null +++ b/docs/other/texts.md @@ -0,0 +1,10 @@ +# Text + +Text files are a secondary file type in WROLPi, which means that they do not yet have a dedicated module. + +## Searching + +When indexes for a text files are generated, they are searched in the following order of precedence: + +1. File path name +2. Text within the file. diff --git a/docs/other/zips.md b/docs/other/zips.md new file mode 100644 index 0000000..9d67987 --- /dev/null +++ b/docs/other/zips.md @@ -0,0 +1,11 @@ +# ZIP + +ZIPs are a secondary file type in WROLPi, which means that they do not yet have a dedicated module, and some features +may not yet be available. + +## Searching + +When indexes for a ZIP files are generated, they are searched in the following order of precedence: + +1. File path name +2. File names within the zip file. diff --git a/docs/system/index.md b/docs/system/index.md index 5d80773..2f63f14 100644 --- a/docs/system/index.md +++ b/docs/system/index.md @@ -1,14 +1,21 @@ # Overview of WROLPi Systems * WROLPi is based off [Debian OS](https://debian.org) and [Raspberry Pi OS](https://www.raspberrypi.com/software/) -* WROLPi has 4 user-facing services: - * [API](#api) - * [App](#app) - * [Map](#map) - * [Zim](#zim) +* WROLPi has several user-facing services: + * [Web](#web) (`:80`) + * [API](#api) (`:8081`) + * [App](#app) (`:8082`) + * [Map](#map) (`:8084`) + * [Zim](#zim) (`:8085`) + * [Help](#help) (`:8086`) ## Services +### Web + +The nginx service which facilitates communication between the other services (especially in the docker containers in +the development environment.) + ### API | Software Project | Purpose | @@ -39,15 +46,46 @@ ### Map -| Software Project | Purpose | -|-------------------------------------------------|------------------------------------------| -| [OpenStreetMap](https://www.openstreetmap.org/) | Provides the Map data | -| [osmium](https://osmcode.org/osmium-tool/) | Used to merge map PBF files. | -| [osm2pgsql](https://osm2pgsql.org/) | Used to import PBF files into Postgresql | +| Software Project | Purpose | +|-------------------------------------------------|-------------------------------------------| +| [OpenStreetMap](https://www.openstreetmap.org/) | Provides the Map data. | +| [osmium](https://osmcode.org/osmium-tool/) | Used to merge map PBF files. | +| [osm2pgsql](https://osm2pgsql.org/) | Used to import PBF files into Postgresql. | ### Zim -| Software Project | Purpose | -|-------------------------------------------------------|-------------------------------| -| [Kiwix](https://kiwix.org) | Provides the ZIM files | -| [Kiwix Server](https://github.com/kiwix/kiwix-tools/) | Hosts the ZIM files interface | +| Software Project | Purpose | +|-------------------------------------------------------|--------------------------------| +| [Kiwix](https://kiwix.org) | Provides the ZIM files. | +| [Kiwix Server](https://github.com/kiwix/kiwix-tools/) | Hosts the ZIM files interface. | + +### Help + +| Software Project | Purpose | +|-----------------------------------|--------------------------------------------| +| [Mkdocs](https://www.mkdocs.org/) | Serves these Markdown documentation files. | + +## Development Only Services + +If using the Docker containers (the development environment), you may have additional services: + +* [Web](#development-web) (`:8080`) +* [Archive](#archive) (`:8083`) + +### Development Web + +| Software Project | Purpose | +|-----------------------------|---------------------------------------------------------------| +| [nginx](https://nginx.org/) | Facilitates integration between development docker containers | + +### Archive + +Separation of the API and the Archive service is necessary to prevent an overly complex API docker container. + +| Software Project | Purpose | +|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| [Python](https://python.org) | The language of the Archive service. | +| [Sanic](https://sanic.dev) | An async web app framework, used to facilitate archiving of webpage in the development environment. | +| [SingleFile](https://github.com/gildas-lormeau/SingleFile) | Used to create Archives. | +| [Readability](https://github.com/mozilla/readability) | Used to extract the article from an Archive. | +| [Chromium](https://chromium.org) | Used to create Archives. | diff --git a/docs/system/primary-secondary-tertiary.md b/docs/system/primary-secondary-tertiary.md new file mode 100644 index 0000000..74988f7 --- /dev/null +++ b/docs/system/primary-secondary-tertiary.md @@ -0,0 +1,12 @@ +# Primary, Secondary, Tertiary. + +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 | VLC application | Subtitle files can be opened 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 | diff --git a/docs/videos/index.md b/docs/videos/index.md index e08210f..e935005 100644 --- a/docs/videos/index.md +++ b/docs/videos/index.md @@ -59,4 +59,12 @@ On this page, you can modify the download frequency, the channel name, or the UR change the channel's directory. At the bottom of this page you will see the statistics of the channel's video files. This is useful if you want to be -sure that all videos were found during a refresh. \ No newline at end of file +sure that all videos were found during a refresh. + +## Searching + +When the indexes for a Video are generated for searching, they are searched in the following order of precedence: + +1. Title +2. Description +3. Subtitles \ No newline at end of file diff --git a/docs/zim/index.md b/docs/zim/index.md index e69de29..50cc1b0 100644 --- a/docs/zim/index.md +++ b/docs/zim/index.md @@ -0,0 +1,31 @@ +# Zim + +The Zim module facilitates viewing, organizing, and downloading Zim files provided by the Kiwix project. + +## Viewer + +The Viewer tab is a simple iframe around the Kiwix service on port `:8085` + +![Zim Viewer Screenshot](zim-viewer-page.png) + +## Manage + +The Manage tab displays a list of Zim files that WROLPi has detected, allowing for search and viewing capabilities. +It also offers a catalog from which select Kiwix Zim files can be subscribed to. The maximum sizes are estimates, based +on the historical data of each specific Zim file. + +![Zim Manage Page](zim-manage-page.png) + +## Subscriptions + +Zim files in the subscription list will be downloaded every 180 days. WROLPi will suggest deleting old Zim files through +a message on the home page, if any are detected at startup. You can safely unsubscribe from any Zim file without +automatic deletion of files. + +### Custom Zim files + +WROLPi will search any Zim file found in the `zims` directory, but not every project from Kiwix can be found in the +subscription list. If you would like to download a specific Zim file, use the **Files Downloader** and save the file to +the `zims` directory. (You may need to restart your WROLPi for the new Zim file to be found.) + +![Downloading a Zim file using the Files Downloader](zim-file-downloader.png) \ No newline at end of file diff --git a/docs/zim/zim-file-downloader.png b/docs/zim/zim-file-downloader.png new file mode 100644 index 0000000..5b1bb4c Binary files /dev/null and b/docs/zim/zim-file-downloader.png differ diff --git a/docs/zim/zim-manage-page.png b/docs/zim/zim-manage-page.png new file mode 100644 index 0000000..9b43501 Binary files /dev/null and b/docs/zim/zim-manage-page.png differ diff --git a/docs/zim/zim-viewer-page.png b/docs/zim/zim-viewer-page.png new file mode 100644 index 0000000..aebbfc3 Binary files /dev/null and b/docs/zim/zim-viewer-page.png differ