https://github.com/lnreader/remote-service
https://github.com/lnreader/remote-service
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/lnreader/remote-service
- Owner: LNReader
- License: mit
- Created: 2023-06-30T04:11:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T06:46:27.000Z (over 1 year ago)
- Last Synced: 2025-03-06T07:43:51.239Z (over 1 year ago)
- Language: Python
- Size: 46.9 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LNReader Remote Service
- Required LNReader version: >= 2.0.0
- `LAN network - Wifi and Windows PC` or `a web server`
## Remote Backup with GUI
1. Start LNReaderRS.exe
2. Enter your machine address `:`
3. Open Android App -> Setting -> Backup -> Self Host Backup
## Remote Backup with command line
1. Clone project
2. Run `pdm install`
3. Run `pdm run server `
4. Open Android App -> Setting -> Backup -> Self Host Backup
## Example
- [How to backup and restore (video)](https://youtu.be/-0H-0j8y9OI)
## Docker Deployment
1. Clone project
2. Configure environment variables (optional):
- `PORT`: Port where the service will run (default: 8000)
- `STORAGE_PATH`: Local path to store LNReader data (default: ~/.LNReader)
3. Run with Docker Compose:
```bash
docker-compose up -d
```
4. Open Android App -> Setting -> Backup -> Self Host Backup with `:`
Example with custom configuration:
```bash
PORT=9000 STORAGE_PATH=/path/to/backup docker-compose up -d
```