mirror of
https://github.com/wrolpi/wrolpi-help.git
synced 2026-11-20 06:56:19 -05:00
Adding getting help docs.
This commit is contained in:
parent
03f794fc9c
commit
228a91ef20
3 changed files with 131 additions and 3 deletions
97
docs/getting-help.md
Normal file
97
docs/getting-help.md
Normal 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`
|
||||
Loading…
Add table
Add a link
Reference in a new issue