rt/wrolpi-help
1
0
Fork 0
mirror of https://github.com/wrolpi/wrolpi-help.git synced 2026-10-26 02:48:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding getting help docs.

Browse source
This commit is contained in:
Roland 2023-11-23 17:01:37 -07:00
parent ccf651766e
commit 5d0fd7ced3
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
3 changed files with 131 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

97
docs/getting-help.md Normal file
View file

@ -0,0 +1,97 @@
# Getting Help Online
Help can be found online at these places:
* WROLPi Discord: [https://discord.gg/HrwFk7nqA2](https://discord.gg/HrwFk7nqA2)
* WROLPi Github: [https://github.com/lrnselfreliance/wrolpi](https://github.com/lrnselfreliance/wrolpi)
* WROLPi Youtube Channel: [https://www.youtube.com/@wrolpi](https://www.youtube.com/@wrolpi)
## `install.sh`
WROLPi may be repaired using the installation script which requires internet, run it like so:
`/opt/wrolpi/install.sh`
# Getting Help Offline
## `repair.sh`
WROLPi has a repair script which will attempt to repair the WROLPi while offline. It copies configs, restarts services,
etc. Run the repair script like so:
`/opt/wrolpi/repair.sh`
## `help.sh`
WROLPi has a help script which checks common failure points on a WROLPi system, run it like so:
`/opt/wrolpi/help.sh`
Example output:
```text
OK: Running on Raspberry Pi
OK: Found wrolpi user
OK: The WROLPi directory exists
OK: The WROLPi blobs directory exists
OK: The WROLPi main script exists
OK: The WROLPi config file exists
OK: Postgres found
OK: Port 5432 is occupied
OK: Postgres is using file socket
OK: Found wrolpi database
OK: WROLPi database is initialized
OK: WROLPi database has files
OK: WROLPi Python virtual environment exists
OK: WROLPi main can be run
OK: WROLPi API systemd exists
OK: WROLPi API service is up
OK: WROLPi API echoed correctly
OK: WROLPi app directory exists
OK: WROLPi app exists
OK: WROLPi app systemd exists
OK: WROLPi app service is up
OK: WROLPi app responded with interface
OK: Port 80 is occupied
OK: nginx systemd exists
OK: Found map database
OK: Map database is initialized
OK: renderd systemd exists
OK: Map app responded
OK: Map initialization blob exists
OK: Leaflet.js exists
OK: The kiwix library file exists
OK: Kiwix app responded
OK: The media directory exists
OK: Can modify media directory
OK: Media directory files are served by nginx
OK: Config can be fetched from nginx
OK: Media directory is owned by wrolpi user
OK: Singlefile can be run
OK: readability exists
OK: wget can be run
OK: yt-dlp can be run
OK: Chromium can be run
OK: ffmpeg can be run
OK: Help service is running
```
The output above will help an experienced developer narrow down the cause of an issue.
# Reset
## Reset API Database
The `wrolpi` database contains the tables and indexes which allow you to search or even browse your WROLPi. A script is
provided which will delete and re-create this database. **Warning you will need to refresh your files!** Run it if the
repair script above fails:
`/opt/wrolpi/scripts/reset_api_db.sh`

9
docs/index.md
View file

@ -1,9 +1,11 @@
# Home
This is the WROLPi help documentation.
Here you will find information about WROLPi, it's modules and how to repair your WROLPi.
## Modules
Information about the parts of the WROLPi interface.
* [Files](modules/files/index.md)
* [Videos](modules/videos/index.md)
* [Archives](modules/archives/index.md)
@ -12,12 +14,17 @@ This is the WROLPi help documentation.
## WROLPi
Information about a WROLPi system.
* [Getting Started](getting-started.md)
* [Getting Help](getting-help.md)
* [Systems](system/index.md)
* [Recommended Hardware](system/recommended-hardware.md)
## Guiding Principals
Principals that influence the design decisions of WROLPi.
1. Storage is cheaper than power.
2. Two is one, one is none.
3. Run silently.

28
docs/modules/map/index.md
View file

@ -23,6 +23,30 @@ time will be.
### 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.
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)
![Downloading of a custom OSM PBF file.](pbf-file-downloader.png)
## Manually Importing
You can manually import a PBF file using the **import_map.sh** script:
`/opt/wrolpi/scripts/import_map.sh /media/wrolpi/map/austria-231121.osm.pbf`
Multiple maps can be imported like so:
`/opt/wrolpi/scripts/import_map.sh /media/wrolpi/map/one.osm.pbf /media/wrolpi/map/two.osm.pbf /media/wrolpi/map/three.osm.pbf`
## Reset Map
If your map is not working, maps cannot be imported, or some other reason, you can reset the map database using the
reset script:
`/opt/wrolpi/scripts/reset_map.sh`
Next, run the repair script:
`/opt/wrolpi/repair.sh`
Browse to your map, you should see the default map. If you do not, you may need to clear your browse's cache. Next,
import your desired maps.