https://github.com/mobuos/kindle-server
Simple web UI for displaying and managing images on a jailbroken Kindle device.
https://github.com/mobuos/kindle-server
docker htmx kindle maud rocketrs rust tailwind
Last synced: 2 months ago
JSON representation
Simple web UI for displaying and managing images on a jailbroken Kindle device.
- Host: GitHub
- URL: https://github.com/mobuos/kindle-server
- Owner: Mobuos
- License: gpl-3.0
- Created: 2024-04-30T20:02:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-26T23:02:38.000Z (6 months ago)
- Last Synced: 2024-11-27T00:20:02.375Z (6 months ago)
- Topics: docker, htmx, kindle, maud, rocketrs, rust, tailwind
- Language: Rust
- Homepage:
- Size: 17.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kindle Server
A small project to make handling images on a jailbroken Kindle easier.
This includes a simple web server and UI for displaying and managing images in `kindle_server/`, a CLI tool in `kindle_cli/` as well as an underlying library for managing the Kindle in `kindle_manager/`.
To run this project you need a jailbroken Kindle, configured to allow SSH connections (over wifi or usb). For more information check out the [MobileRead Forums](https://www.mobileread.com/forums/showthread.php?t=320564). This project was only tested with a PW2 Kindle.
> This project is not under active development, but feel free to reach out :)
---
You will also need a computer acting as a server, here's how I run the docker container:
```bash
docker build . -t kindle_server
docker run -d -p 8000:8000 -v $SSH_AUTH_SOCK:/ssh-agent -e SSH_AUTH_SOCK=/ssh-agent -v ~/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro -v ~/.ssh/known_hosts:/root/.ssh/known_hosts:ro --rm --name kindle kindle_server
```
**Note:** This will copy your `id_ed25519` key to the container, and forward your ssh-agent to avoid having to input a passphrase inside the container as well, adapt the command to fit your needs. Depending on how your server is set-up you might need to manually login into it and unlock the ssh key before running the server.
Make sure to run `cargo run -p kindle_cli -- prep` to avoid having the kindle fall asleep.
---
For development, inside the `kindle_server` folder:
To re-build tailwind stylesheets after changes (Requires Tailwind CLI):
```bash
./tailwind -i ./kindle_server/static/res/style.css -o ./kindle_server/static/res/tw.css --watch
```
To run the server:
```bash
cargo run -p kindle_server
```
To run the CLI:
```bash
cargo run -p kindle_cli -- help
```
To constantly re-run the server after changes:
```bash
cargo-watch -q -c -x 'run -p kindle_server'
```
Thanks to the following projects for the inspiration and in helping to understand how to deal with Kindle devices:
- https://github.com/forestpurnell/kindletron
- https://github.com/mattzzw/kindle-clock