1
0
Fork 0
mirror of https://github.com/imtbl/hydrus-server-docker synced 2024-05-08 14:43:45 +12:00
hydrus-server-docker/README.md
2019-02-10 00:29:35 +01:00

6.1 KiB

hydrus-server-docker hydrus server version Build status Docker Hub build

hydrus server running on Alpine

This is a simple Alpine-based Docker setup for running hydrus server from source. It was mainly created for making it easier to run hydrus server together with hydrusrv, but can of course also be used on its own.

The latest build runs hydrus server version 339.

Table of contents

Install

The easiest way to install is via Docker Hub:

user@local:~$ docker pull mserajnik/hydrus-server-docker

By default, this will pull the latest build. To specify an image with a specific version of hydrus server, provide the version number as tag, e.g.:

user@local:~$ docker pull mserajnik/hydrus-server-docker:339

See here for all the available version numbers/tags.

Alternatively, you can clone this repository and build the image yourself:

user@local:~$ git clone https://github.com/mserajnik/hydrus-server-docker.git
user@local:~$ cd hydrus-server-docker
user@local:hydrus-server-docker$ docker build . -t hydrus-server-docker

Dependencies

Updating

If you have installed via Docker Hub, just pull the updated image. Otherwise, pull from this repository and make a new build.

This repository follows semantic versioning and any breaking changes that require additional attention will be released under a new major version (e.g., 2.0.0). Minor version updates (e.g., 1.1.0 or 1.2.0) are therefore always safe to simply install via the routine mentioned before.

When necessary, this section will be expanded with upgrade guides to new major versions.

Upgrading from 1.x to 2.x

Upgrading from 1.x to 2.x can be done via pulling the updated image from Docker Hub or building it yourself and requires no further manual changes.

Since there have been issues with running the pre-compiled version of hydrus server 335+ (which made the switch to Python 3) on the previous Docker setup, starting with 2.0.0, the Docker image is now based on Alpine (instead of Debian) and runs hydrus server from source.

This approximately halves the resulting image size while at the same time making it easier to adapt for future changes/dependencies.

Usage

First, you need to bind the exposed ports. This can be done automatically using -P but it is recommended to bind them manually instead since having changing ports every time you run a new container might be annoying when used in combination with other services.

hydrus-server-docker exposes the following three ports by default:

  • 45870/tcp
  • 45871/tcp
  • 45872/tcp

These are used to access the different services. 45870 is the default port for the server administration service while 45871 and 45872 are used for repositories. You will generally have two (one for tags and one for files), but if you add more, you will also need to expose additional ports.

Per default, hydrus-server-docker stores its databases and media inside the /data directory. It is highly recommended to create a named volume and mount it to the same location if you wish to persist the data beyond the lifetime of the container and/or access it on the host:

user@local:~$ docker volume create hydrus-server-data

After creating your named volume, you can run the container. Here is a full example with all the options mentioned above:

user@local:~$ docker run -p 45870:45870 -p 45871:45871 -p 45872:45872 -v hydrus-server-data:/data -d mserajnik/hydrus-server-docker

Additional configuration when building

UID/GID

By default, the user that owns the data and runs the server inside the container has the UID 1000 and the GID 1000. You can make a build providing the arguments HOST_USER_ID and HOST_GROUP_ID to change these defaults.

This is useful if you want to access the data outside the container with a user with different ID's without hassle. In such a case, HOST_USER_ID and HOST_GROUP_ID should match the user that is going to access the data on the host.

Donate

If you like hydrus-server-docker and want to buy me a coffee, feel free to donate via PayPal:

Donate via PayPal

Alternatively, you can also send me BTC:

Donate BTC
13jRyroNn8QF4mbGZxKS6mR3PsxjYTsGsu

Donations are unnecessary, but very much appreciated. :)

Maintainer

mserajnik

Contribute

You are welcome to help out!

Open an issue or submit a pull request.

License

MIT © Michael Serajnik