https://github.com/kaiser-chris/kindle-proxy
This application proxies different web novel pages and renders them in a Kindle friendly web page.
https://github.com/kaiser-chris/kindle-proxy
docker java kindle proxy-server
Last synced: over 1 year ago
JSON representation
This application proxies different web novel pages and renders them in a Kindle friendly web page.
- Host: GitHub
- URL: https://github.com/kaiser-chris/kindle-proxy
- Owner: kaiser-chris
- License: mit
- Created: 2021-07-24T01:27:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T07:28:58.000Z (almost 2 years ago)
- Last Synced: 2024-08-23T08:39:32.991Z (almost 2 years ago)
- Topics: docker, java, kindle, proxy-server
- Language: Java
- Homepage:
- Size: 2.59 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Kindle Proxy
This application proxies different web novel pages and renders them in a Kindle friendly web page.
It is meant to be used in the Kindle Web browser.
## Supported Pages
- [Royal Road](https://www.royalroad.com/)
- [The Wandering Inn](https://wanderinginn.com/)
## Tested Devices
These devices below have been tested. If you want to add a device you have tested please create an issue.
- Kindle Paperwhite 2
- Kindle Paperwhite (11th generation)
Here is a guide to identify which kindle you own: https://www.androidauthority.com/which-kindle-model-do-i-have-1073996/
# Running it yourself
To run the Kindle Proxy it is recommended to use the provided docker images.
Images are currently published to the GitHub package registry.
## Environment Variables
These variables can be set to configure your setup.
| Variable | Default Value | Description |
|------------------------------|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ROYAL_ROAD_PROFILE | Empty | Set this to your Royal Road public profile id (can be found in the url) to show only your favorite items in the book overview. When it is left blank only the 'Best Rated' books are listed since Royal Road has too much content to list everything. |
| SETTINGS_DEFAULT_FONT | Literata | Set this to overwrite the default font. This value needs to be part of the font list. |
| SETTINGS_FONT_LIST | Literata, Roboto, Merriweather, Open Sans | Set this to overwrite the default list of selectable fonts. |
| SETTINGS_DEFAULT_FONT_SIZE | 24 | Set this to overwrite the default font size. This value needs to be part of the font size scale. This is an integer value in Pixel. |
| SETTINGS_FONT_SIZE_SCALE | 12, 16, 20, 24, 28, 32, 36, 40, 44, 48 | Set this to overwrite the default font size scale in the settings. Needs to be exactly 10 integer entries split by commas (,). |
| SETTINGS_DEFAULT_SHOW_FOOTER | true | Set this to overwrite the default footer rendering behaviour. The footer contains the chapter name as well as the location inside a chapter (Page). This is a boolean. |
## Examples
Below are a few simple examples to run the service using docker.
### docker compose
```
version: "3.9"
services:
kindle-proxy:
image: ghcr.io/kaiser-chris/kindle-proxy:latest
ports:
- 80:80
```
### docker run
```
docker run -d -p 80:80 ghcr.io/kaiser-chris/kindle-proxy:latest
```
# Screenshots
| Home Page | Chapter list | Settings page |
|:----------------------------------------------:|:------------------------------------------------------------------:|:------------------------------------------------:|
|  |  |  |
| Content page | Content page with menu open | |
|  |  | |
# Attribution
In development of this application multiple assets by other people and groups have been used.
Their authors and licences can be found on the [Attribution Page](.docs/ATTRIBUTION.md).