mirror of https://github.com/koreader/koreader
Installation via Toltec: extra steps no longer needed after https://github.com/toltec-dev/toltec/pull/441
gbyl
3 years ago
parent
20cfd5630f
commit
0e2fdbea25
@ -1,87 +1,56 @@
|
||||
## SSH into your device
|
||||
## SSH Login
|
||||
|
||||
0. Windows users may need to install an [OpenSSH Client](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse#install-openssh-using-windows-settings)
|
||||
1. Connect your device via USB
|
||||
2. Find your device password `Menu > Settings > Help > Copyright and Licenses`
|
||||
3. Open terminal and run: `ssh root@10.11.99.1`
|
||||
|
||||
## Installing
|
||||
|
||||
### Installation via Toltec
|
||||
|
||||
1. SSH into your device and install [Toltec](https://github.com/toltec-dev/toltec#install-it)
|
||||
2. Run `opkg install koreader`
|
||||
3. Create a Toltec-compatible service file by running:
|
||||
2. Find your device password: Menu > Settings > Help > Copyright and Licenses
|
||||
3. Open terminal and run:
|
||||
```
|
||||
sed 's|/.*sh|/opt/bin/koreader|' /opt/koreader/koreader.service > /etc/systemd/system/koreader.service
|
||||
```
|
||||
4. Launch KOReader:
|
||||
```
|
||||
systemctl start koreader
|
||||
ssh root@10.11.99.1
|
||||
```
|
||||
- Check for updates from within KOReader as Toltec may not have yet indexed the latest release
|
||||
- After every reMarkable firmware update, run `toltecctl reenable` and re-run step 3
|
||||
|
||||
### Manual installation
|
||||
## Installation via Toltec
|
||||
|
||||
1. Download the [latest release](https://github.com/koreader/koreader/releases) of KOReader
|
||||
2. Open terminal and navigate to your downloads folder:
|
||||
1. Connect your device to Wi-Fi and install [Toltec](https://github.com/toltec-dev/toltec/tree/testing#install-it)
|
||||
5. Download and install KOReader:
|
||||
```
|
||||
cd ~/Downloads
|
||||
opkg install koreader
|
||||
```
|
||||
3. Copy the zip file to your device by running:
|
||||
|
||||
- You may also install a [launcher](https://toltec-dev.org/stable/)
|
||||
|
||||
## Manual installation
|
||||
|
||||
0. Install [rm2fb](https://github.com/ddvk/remarkable2-framebuffer#installation) (reMarkable 2)
|
||||
1. Download the [latest release](https://ota.koreader.rocks/) of KOReader
|
||||
2. Copy the file to your device:
|
||||
```
|
||||
scp ~/koreader-remarkable-*.zip root@10.11.99.1:
|
||||
scp koreader-remarkable-*targz root@10.11.99.1:
|
||||
```
|
||||
4. SSH into your device:
|
||||
4. Log into your device:
|
||||
```
|
||||
ssh root@10.11.99.1
|
||||
```
|
||||
5. Unzip the file:
|
||||
5. Extract the contents of the file:
|
||||
```
|
||||
unzip ~/koreader-remarkable-*.zip
|
||||
tar -xf ~/koreader-remarkable-*targz
|
||||
```
|
||||
6. Copy the service file to the system directory:
|
||||
6. Copy the systemd unit file to the system directory:
|
||||
```
|
||||
cp -v ~/koreader/*.service /etc/systemd/system/
|
||||
cp ~/koreader/*service /etc/systemd/system/
|
||||
```
|
||||
7. Install [rm2fb](https://github.com/ddvk/remarkable2-framebuffer#installation) (reMarkable 2 only)
|
||||
8. Launch KOReader:
|
||||
7. Launch KOReader:
|
||||
```
|
||||
systemctl start koreader
|
||||
```
|
||||
|
||||
## Launching
|
||||
|
||||
### Automatic launch
|
||||
|
||||
To launch KOReader at startup, SSH into your device and run:
|
||||
- To launch KOReader by holding down the middle button for 3 seconds (reMarkable 1):
|
||||
```
|
||||
systemctl enable --now koreader && systemctl disable xochitl
|
||||
reboot
|
||||
```
|
||||
|
||||
### External launcher
|
||||
|
||||
Launcher applications such as [oxide](https://github.com/Eeems/oxide), [draft](https://github.com/dixonary/draft-reMarkable) and [remux](https://rmkit.dev/apps/remux) can be installed via [Toltec](https://github.com/toltec-dev/toltec#install-it), for example:
|
||||
systemctl enable --now button-listen
|
||||
```
|
||||
opkg install oxide
|
||||
- To launch KOReader at startup:
|
||||
```
|
||||
|
||||
### Middle button launch
|
||||
|
||||
To launch KOReader by holding down the middle button for 3 seconds:
|
||||
systemctl enable --now koreader && systemctl disable --now xochitl
|
||||
```
|
||||
cp -v /opt/koreader/button-listen.service /etc/systemd/system/
|
||||
systemctl enable --now button-listen
|
||||
```
|
||||
|
||||
## Optional
|
||||
|
||||
### Override System Splashscreens
|
||||
|
||||
To use KOReader screensavers for poweroff and reboot events:
|
||||
- To override reMarkable's splashscreens for poweroff and reboot events:
|
||||
```
|
||||
systemctl disable remarkable-shutdown remarkable-reboot
|
||||
reboot
|
||||
```
|
||||
Loading…
Reference in New Issue