Moving modules into a new modules directory. Adding installation instructions to fascilitate offline installation.

This commit is contained in:
Roland 2023-11-23 16:17:04 -07:00
parent 322e0e1bd8
commit a2c4aee9ad
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
24 changed files with 69 additions and 7 deletions

62
docs/getting-started.md Normal file
View file

@ -0,0 +1,62 @@
# Getting Started
For hardware recommendations, see [Recommended Hardware](system/recommended-hardware.md).
## Finish WROLPi Installation
To finish your WROLPi installation follow these steps:
1. Modify fstab to mount your external drive. In the example below, `/dev/sda1` will be mounted to `/media/wrolpi`
1. `echo '/dev/sda1 /media/wrolpi auto defaults,nofail 0 0' | sudo tee -a /etc/fstab`
2. Finish the installation with the repair script: `sudo bash /opt/wrolpi/repair.sh`
3. Reboot: `sudo reboot`
4. After reboot, browse to `http://wrolpi.local` or `http://127.0.0.1` on the WROLPi itself.
5. [Refresh your files](modules/files/index.md#refreshing)
# Creating a new WROLPi
## Raspberry Pi
The following instructions are the steps necessary to create a new WROLPi, either as a backup, or to restore your WROLPi
on a new Raspberry Pi.
### Image an SD Card on Linux
1. Plug in your SD card, find its device path with: `sudo blkid`
2. Extract and copy the WROLPi image to your drive (/dev/sdb in this example):
* `xzcat WROLPi-v0.10-aarch64-desktop.img.xz | sudo dd of=/dev/sdb status=progress`
### Image an SD Card on Windows
1. Copy the WROLPi image to your micro SD card using [Balena Etcher](https://www.balena.io/etcher)
### First Boot
1. Unplug your Raspberry Pi
2. Insert the micro SD card from step 2 into your Raspberry Pi
3. Connect any peripherals to your Raspberry Pi, then turn it on.
4. Login as the **pi** user with the password **wrolpi**
5. Launch the Terminal application
1. Change your password with: `passwd`
2. Modify fstab to mount your external drive to **/media/wrolpi**
* `echo '/dev/sda1 /media/wrolpi auto defaults,nofail 0 0' | sudo tee -a /etc/fstab`
3. Finish the installation with the repair script:
* `sudo bash /opt/wrolpi/repair.sh`
4. Reboot: `sudo reboot`
## Debian
The following instructions are the steps necessary to create a new WROLPi, either as a backup, or to restore your WROLPi
on a new Debian computer.
1. Copy the Debian WROLPi ISO to a thumb-drive.
2. Insert the thumb-drive into the laptop, boot to the thumb-drive.
1. Select **Start Installer**
2. Install Debian 12.
3. Unplug the thumb-drive after the installation has completed
4. Login as the user you created during installation.
5. Switch to the root user: `su -`
6. Finish the installation with the repair script: `sudo bash /opt/wrolpi/repair.sh`
7. Reboot: `sudo reboot`
8. Join the Hotspot or browse to `http://wrolpi.local` or the IP address of your WROLPi!
9. [Refresh your files](modules/files/index.md#refreshing)

View file

@ -4,14 +4,15 @@ This is the WROLPi help documentation.
## Modules
* [Files](files/index.md)
* [Videos](videos/index.md)
* [Archives](archives/index.md)
* [Map](map/index.md)
* [Zim](zim/index.md)
* [Files](modules/files/index.md)
* [Videos](modules/videos/index.md)
* [Archives](modules/archives/index.md)
* [Map](modules/map/index.md)
* [Zim](modules/zim/index.md)
## WROLPi
* [Getting Started](getting-started.md)
* [Systems](system/index.md)
* [Recommended Hardware](system/recommended-hardware.md)

View file

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 112 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 82 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 295 KiB

After

Width:  |  Height:  |  Size: 295 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 59 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Before After
Before After

View file

@ -11,5 +11,4 @@ When indexes for an EPUB are generated, they are searched in the following order
1. Title
2. Author
3. Text
4. File path name
3. eBook contents