rt/wrolpi-help
1
0
Fork 0
mirror of https://github.com/wrolpi/wrolpi-help.git synced 2026-10-26 19:01:40 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
wrolpi-help/docs/system/getting-help.md

112 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
# Getting Help
Adding Controller documentation and screnshots.
2026-02-22 20:04:31 -07:00
Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
## Online
Adding getting help docs.
2023-11-23 17:01:37 -07:00
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)
Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
### `install.sh`
Adding getting help docs.
2023-11-23 17:01:37 -07:00
WROLPi may be repaired using the installation script which requires internet, run it like so:
`/opt/wrolpi/install.sh`
Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
## Offline
Adding getting help docs.
2023-11-23 17:01:37 -07:00
Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
### `repair.sh`
Adding getting help docs.
2023-11-23 17:01:37 -07:00
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`
Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
### `help.sh`
Adding getting help docs.
2023-11-23 17:01:37 -07:00
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
Updating help script example response.
2024-07-31 11:57:54 -06:00
WROLPi version: 0.13.1-beta
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: Running on Raspberry Pi 5
Adding getting help docs.
2023-11-23 17:01:37 -07:00
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
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: Found wrolpi database at /media/wrolpi/config/wrolpi.db
OK: WROLPi database passes quick_check
Adding getting help docs.
2023-11-23 17:01:37 -07:00
OK: WROLPi database is initialized
OK: WROLPi database has files
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: Controller Python virtual environment exists
OK: WROLPi Controller systemd exists
OK: WROLPi Controller service is up
OK: WROLPi Controller health check passed
OK: WROL Mode is inactive
Adding getting help docs.
2023-11-23 17:01:37 -07:00
OK: WROLPi Python virtual environment exists
OK: WROLPi main can be run
Updating help script example response.
2024-07-31 11:57:54 -06:00
OK: Sanic can be run
Adding getting help docs.
2023-11-23 17:01:37 -07:00
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
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: WROLPi app responded with UI
OK: Caddy is installed
Migrating nginx docs to caddy.
2026-03-07 18:27:43 -07:00
OK: Caddy systemd exists
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: Caddy service is running
OK: Caddy HTTPS proxy responded on :443
Adding getting help docs.
2023-11-23 17:01:37 -07:00
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: Map viewer responded
OK: Map static assets exist
OK: Found 3 PMTiles map files
Adding getting help docs.
2023-11-23 17:01:37 -07:00
OK: The kiwix library file exists
OK: Kiwix app responded
OK: The media directory exists
OK: Can modify media directory
Adding backup instructions.
2024-05-08 20:07:19 -06:00
OK: Media directory is a mounted drive
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: Media directory files are served by caddy
OK: Config can be fetched from caddy
Adding getting help docs.
2023-11-23 17:01:37 -07:00
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
Updating help script example response.
2024-07-31 11:57:54 -06:00
OK: Help mkdocs can be run
Adding getting help docs.
2023-11-23 17:01:37 -07:00
OK: Help service is running
Updating help script example response.
2024-07-31 11:57:54 -06:00
OK: Can ping 1.1.1.1
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
OK: Can ping one.one.one.one
Adding getting help docs.
2023-11-23 17:01:37 -07:00
```
The output above will help an experienced developer narrow down the cause of an issue.
Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
## Reset
Adding getting help docs.
2023-11-23 17:01:37 -07:00
Moving getting started and getting help into system to avoid cluttery navigation.
2023-11-23 17:10:27 -07:00
### Reset API Database
Adding getting help docs.
2023-11-23 17:01:37 -07:00
Document SQLite database and remove Postgres references. WROLPi no longer runs PostgreSQL; the API database is SQLite in the media directory and maps use PMTiles. Update help pages, service tables, and example diagnostics accordingly.
2026-07-18 13:17:27 -06:00
The SQLite database at `/media/wrolpi/config/wrolpi.db` contains the tables and indexes which allow you to search or
browse your WROLPi. A script is provided which will delete this database (the API recreates it on next start).
**Warning: you will need to refresh your files!** Run it if the repair script above fails:
Adding getting help docs.
2023-11-23 17:01:37 -07:00
Adding Controller documentation and screnshots.
2026-02-22 20:04:31 -07:00
`/opt/wrolpi/scripts/reset_api_db.sh`
Reference in a new issue Copy permalink