hydrus-server-docker

Built version of hydrus server running on Debian

This is a simple Debian-based Docker setup for running the built version of hydrus server. 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 332.

Table of contents

• Install
  • Dependencies
  • Updating
• Usage
  • Additional configuration when building
    • UID/GID
• Caveats
• Donate
• Maintainer
• Contribute
• License

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:332

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

• Docker

Updating

If you have installed via Docker Hub, just pull the updated image. Otherwise, just 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.

Usage

hydrus-server-docker mounts a volume on /data that is used to store the databases and media. It is highly recommended to create a named volume:

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

Likewise, 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.

After creating your named volume, you can run the container:

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.

Caveats

• The built image also includes the hydrus client due to the built releases always including both of it and the server. This adds quite a bit of size to the image.
• To upgrade hydrus server to a new version, you need to either make a new build yourself (when using --no-cache it will automatically download the latest version of hydrus server), upgrade it directly inside the running container or wait until I make a new release. I will try to keep up with every new hydrus release (usually weekly on Wednesdays), but cannot make any promises.

Donate

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

Alternatively, you can also send me 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