This image is based on linuxserver.io's guacamole image. It is largely inspired by linuxserver.io's calibre image. Check their work, it great!
Hakuneko is a cross-platform downloader for manga and anime from various websites. HakuNeko was made to help users downloading media for circumstances that require offline usage. The philosophy is ad-hoc consumption, get it when you going to read/watch it. It is not meant to be a mass downloader to stock up thousands of chapters that are just collected and will probably never be read.
The architectures supported by this image are:
| Architecture | Tag |
|---|---|
| x86-64 | latest |
Here are some example snippets to help you get started creating a container.
docker create \
--name=hakuneko \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e GUAC_USER=abc `#optional` \
-e GUAC_PASS=900150983cd24fb0d6963f7d28e17f72 `#optional` \
-e APPNAME="hakuneko-desktop" \
-p 8080:8080 \
--cap-add=CAP_SYS_ADMIN \
-v /path/to/data:/config \
--restart unless-stopped \
shlagevuk/hakuneko
Note that Hakuneko use chrome in electron framework, chrome need kernel right to clone namespace.
Compatible with docker-compose v2 schemas.
---
version: "2"
services:
calibre:
image: shlagevuk/hakuneko
container_name: hakuneko
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- GUAC_USER=abc #optional
- GUAC_PASS=900150983cd24fb0d6963f7d28e17f72 #optional
- cap-add=CAP_SYS_ADMIN
- APPNAME="hakuneko-desktop"
volumes:
- /path/to/data:/config
ports:
- 8080:8080
restart: unless-stopped
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
| Parameter | Function |
|---|---|
-p 8080 |
Hakuneko desktop gui. |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Europe/London |
Specify a timezone to use EG Europe/London. |
-e GUAC_USER=abc |
Username for the hakuneko desktop gui. |
-e GUAC_PASS=900150983cd24fb0d6963f7d28e17f72 |
Password's md5 hash for the hakuneko desktop gui. |
-v /config |
Where calibre should store its database and library. |
When using volumes (-v flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
This image sets up hakuneko desktop app and makes its interface available via Guacamole server in the browser. The interface is available at http://your-ip:8080.
By default, there is no username or password set. Custom usernames and passwords can be set via optional docker environment variables. Keep in mind that the GUACPASS variable accepts the md5 hash of the desired password (the sample above is the hash for abc). The md5 hash can be generated by either of the following commands:
echo -n password | openssl md5
printf '%s' password | md5sum
You can access advanced features of the Guacamole remote desktop using ctrl+alt+shift enabling you to use remote copy/paste and different languages.
- Shell access whilst the container is running:
docker exec -it hakuneko /bin/bash - To monitor the logs of the container in realtime:
docker logs -f hakuneko - container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hakuneko
- image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' shlagevuk/hakuneko
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
- Update the image:
docker pull shlagevuk/hakuneko - Stop the running container:
docker stop hakuneko - Delete the container:
docker rm hakuneko - Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved) - Start the new container:
docker start hakuneko - You can also remove the old dangling images:
docker image prune
- Update all images:
docker-compose pull- or update a single image:
docker-compose pull hakuneko
- or update a single image:
- Let compose update all containers as necessary:
docker-compose up -d- or update a single container:
docker-compose up -d hakuneko
- or update a single container:
- You can also remove the old dangling images:
docker image prune
- Pull the latest image at its tag and replace it with the same env variables in one run:
docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ --run-once hakuneko
Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
- You can also remove the old dangling images:
docker image prune
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/shlagevuk/docker-hakuneko.git
cd docker-hakuneko
docker build \
--no-cache \
--pull \
-t hakuneko:latest .
- 06.10.20: - Fix docker create command and minor change
- 29.09.20: - Fix blank page thanks to akhan23wgu
- 24.09.19: - Initial release.