From a2c4aee9adf8cc556bd93fd62c6439124c14eab4 Mon Sep 17 00:00:00 2001 From: Roland Date: Thu, 23 Nov 2023 16:17:04 -0700 Subject: [PATCH] Moving modules into a new modules directory. Adding installation instructions to fascilitate offline installation. --- docs/getting-started.md | 62 ++++++++++++++++++ docs/index.md | 11 ++-- docs/{ => modules}/archives/archive-page.png | Bin docs/{ => modules}/archives/files.md | 0 docs/{ => modules}/archives/index.md | 0 .../archives/readability-preview.png | Bin .../{ => modules}/files/3d-benchy-preview.png | Bin docs/{ => modules}/files/files-page.png | Bin docs/{ => modules}/files/index.md | 0 docs/{ => modules}/files/pdf-preview.png | Bin docs/{ => modules}/map/index.md | 0 docs/{ => modules}/map/map-manage.png | Bin docs/{ => modules}/map/map-viewer.png | Bin .../{ => modules}/map/pbf-file-downloader.png | Bin .../videos/channel-edit-page.png | Bin .../{ => modules}/videos/channel-new-page.png | Bin docs/{ => modules}/videos/files.md | 0 docs/{ => modules}/videos/index.md | 0 .../videos/video-download-modal.png | Bin docs/{ => modules}/zim/index.md | 0 .../{ => modules}/zim/zim-file-downloader.png | Bin docs/{ => modules}/zim/zim-manage-page.png | Bin docs/{ => modules}/zim/zim-viewer-page.png | Bin docs/other/ebooks.md | 3 +- 24 files changed, 69 insertions(+), 7 deletions(-) create mode 100644 docs/getting-started.md rename docs/{ => modules}/archives/archive-page.png (100%) rename docs/{ => modules}/archives/files.md (100%) rename docs/{ => modules}/archives/index.md (100%) rename docs/{ => modules}/archives/readability-preview.png (100%) rename docs/{ => modules}/files/3d-benchy-preview.png (100%) rename docs/{ => modules}/files/files-page.png (100%) rename docs/{ => modules}/files/index.md (100%) rename docs/{ => modules}/files/pdf-preview.png (100%) rename docs/{ => modules}/map/index.md (100%) rename docs/{ => modules}/map/map-manage.png (100%) rename docs/{ => modules}/map/map-viewer.png (100%) rename docs/{ => modules}/map/pbf-file-downloader.png (100%) rename docs/{ => modules}/videos/channel-edit-page.png (100%) rename docs/{ => modules}/videos/channel-new-page.png (100%) rename docs/{ => modules}/videos/files.md (100%) rename docs/{ => modules}/videos/index.md (100%) rename docs/{ => modules}/videos/video-download-modal.png (100%) rename docs/{ => modules}/zim/index.md (100%) rename docs/{ => modules}/zim/zim-file-downloader.png (100%) rename docs/{ => modules}/zim/zim-manage-page.png (100%) rename docs/{ => modules}/zim/zim-viewer-page.png (100%) diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000..b91e5df --- /dev/null +++ b/docs/getting-started.md @@ -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) diff --git a/docs/index.md b/docs/index.md index 7cf8e67..093e76d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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) diff --git a/docs/archives/archive-page.png b/docs/modules/archives/archive-page.png similarity index 100% rename from docs/archives/archive-page.png rename to docs/modules/archives/archive-page.png diff --git a/docs/archives/files.md b/docs/modules/archives/files.md similarity index 100% rename from docs/archives/files.md rename to docs/modules/archives/files.md diff --git a/docs/archives/index.md b/docs/modules/archives/index.md similarity index 100% rename from docs/archives/index.md rename to docs/modules/archives/index.md diff --git a/docs/archives/readability-preview.png b/docs/modules/archives/readability-preview.png similarity index 100% rename from docs/archives/readability-preview.png rename to docs/modules/archives/readability-preview.png diff --git a/docs/files/3d-benchy-preview.png b/docs/modules/files/3d-benchy-preview.png similarity index 100% rename from docs/files/3d-benchy-preview.png rename to docs/modules/files/3d-benchy-preview.png diff --git a/docs/files/files-page.png b/docs/modules/files/files-page.png similarity index 100% rename from docs/files/files-page.png rename to docs/modules/files/files-page.png diff --git a/docs/files/index.md b/docs/modules/files/index.md similarity index 100% rename from docs/files/index.md rename to docs/modules/files/index.md diff --git a/docs/files/pdf-preview.png b/docs/modules/files/pdf-preview.png similarity index 100% rename from docs/files/pdf-preview.png rename to docs/modules/files/pdf-preview.png diff --git a/docs/map/index.md b/docs/modules/map/index.md similarity index 100% rename from docs/map/index.md rename to docs/modules/map/index.md diff --git a/docs/map/map-manage.png b/docs/modules/map/map-manage.png similarity index 100% rename from docs/map/map-manage.png rename to docs/modules/map/map-manage.png diff --git a/docs/map/map-viewer.png b/docs/modules/map/map-viewer.png similarity index 100% rename from docs/map/map-viewer.png rename to docs/modules/map/map-viewer.png diff --git a/docs/map/pbf-file-downloader.png b/docs/modules/map/pbf-file-downloader.png similarity index 100% rename from docs/map/pbf-file-downloader.png rename to docs/modules/map/pbf-file-downloader.png diff --git a/docs/videos/channel-edit-page.png b/docs/modules/videos/channel-edit-page.png similarity index 100% rename from docs/videos/channel-edit-page.png rename to docs/modules/videos/channel-edit-page.png diff --git a/docs/videos/channel-new-page.png b/docs/modules/videos/channel-new-page.png similarity index 100% rename from docs/videos/channel-new-page.png rename to docs/modules/videos/channel-new-page.png diff --git a/docs/videos/files.md b/docs/modules/videos/files.md similarity index 100% rename from docs/videos/files.md rename to docs/modules/videos/files.md diff --git a/docs/videos/index.md b/docs/modules/videos/index.md similarity index 100% rename from docs/videos/index.md rename to docs/modules/videos/index.md diff --git a/docs/videos/video-download-modal.png b/docs/modules/videos/video-download-modal.png similarity index 100% rename from docs/videos/video-download-modal.png rename to docs/modules/videos/video-download-modal.png diff --git a/docs/zim/index.md b/docs/modules/zim/index.md similarity index 100% rename from docs/zim/index.md rename to docs/modules/zim/index.md diff --git a/docs/zim/zim-file-downloader.png b/docs/modules/zim/zim-file-downloader.png similarity index 100% rename from docs/zim/zim-file-downloader.png rename to docs/modules/zim/zim-file-downloader.png diff --git a/docs/zim/zim-manage-page.png b/docs/modules/zim/zim-manage-page.png similarity index 100% rename from docs/zim/zim-manage-page.png rename to docs/modules/zim/zim-manage-page.png diff --git a/docs/zim/zim-viewer-page.png b/docs/modules/zim/zim-viewer-page.png similarity index 100% rename from docs/zim/zim-viewer-page.png rename to docs/modules/zim/zim-viewer-page.png diff --git a/docs/other/ebooks.md b/docs/other/ebooks.md index 66532ba..ab3d76c 100644 --- a/docs/other/ebooks.md +++ b/docs/other/ebooks.md @@ -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 \ No newline at end of file +3. eBook contents \ No newline at end of file