Seafile Docker image

• github reference project : https://github.com/strator-dev/docker-seafile/
• docker hub referece image : https://hub.docker.com/r/stratordev/seafile/

Concept

The goal of this image : to create a seafile docker image that can be used without the need to run configurations scripts manually or to tweek configurations files. Most of configuration values can be passed to the first docker run command with configuration variables.

Easy usage

Choose a data path on your server path.

sudo mkdir -p /this/will/be/your/data/path

sudo docker \
  run \
  -d \
  -e "SEAFILE_VERSION=6.0.5" \
  -e "[email protected]" \
  -e "SEAFILE_ADMIN_PASSWORD=Rw5Knb3d91" \
  -e "SEAFILE_HOST=this.ismyhost.com" \
  -e "SEAFILE_PORT=8080" \
  -v "/this/will/be/your/data/path:/opt/seafile" \
  -p 0.0.0.0:8080:8080 \
  --name="seafile" \
  stratordev/seafile

And that's it.

The first time, the data path will be filled with everything that needs to be done to have a working seafile server with an admin whose email adress is [email protected] and whose passord is Rw5Knb3d91.

While this is the fastest way to init & start a seafile server, the "(Init) + (classic run) usage" is prefered (see corresponding section below).

Configuration

Variable	Usage	Target
SEAFILE_VERSION	The seafile server version you want to use. If not specified 6.0.5 is used. Mandatory for upgrade	init + upgrade
SEAFILE_ADMIN_EMAIL	The admin email (that is the login on seafile server). There is a default value, but I won't document it to make sure you won't use it.	init
SEAFILE_ADMIN_PASSWORD	The admin password. There is a default value, but I won't document it to make sure you won't use it.	init
SEAFILE_HOST	The host as seen from internet (or from the users). If you use a complex system of vhosts and reverse proxies in front of that image, this is the hostname configured in you vhost configuration that may be different than the one where you run your docker image.	init
SEAFILE_PORT	The port as seen from internet (or from the users). If you use a complex system of vhosts and reverse proxies in front of that image, this is the port configured in you vhost configuration that my be different than the one you bind on your docker command. Default value is empty which will be considered as defaut port (80 for http, 443 for https, see SEAFILE_USE_HTTPS for https)	init
SEAFILE_USE_HTTPS	1 if the protocol as seen from the internet (or from the users) is https. That image only provide http as output, but you may use it through nginx/apache reverse proxy and provide https encryption through that layer. If you do so, define that variable to "1".	init
SEAFILE_LDAP_URL	The ldap url if you're using a ldap server to identify accounts. (if set an not empty, an ldap section will be created in the configuration files, and a ldap server will be used. If you don't know what a ldap server is, don't specify that variable)	init
SEAFILE_LDAP_USER_DN	The ldap user dn configuration value (see seafile manual for details)	init
SEAFILE_LDAP_BASE	The ldap base configuration value (see seafile manual for details)	init
SEAFILE_LDAP_PASSWORD	The ldap password configuration value (see seafile manual for details)	init
SEAFILE_LDAP_LOGIN_ATTR	The ldap login attr configuration value (see seafile manual for details)	init

(Init) + (classic run) usage

The usage presented in the "Easy usage" section need to provide configuration values on each run, while it's only needed on the first run. If you're bothered by that you can do:

sudo docker \
  run \
  -it \
  --rm=true \
  -e "SEAFILE_VERSION=6.0.5" \
  -e "[email protected]" \
  -e "SEAFILE_ADMIN_PASSWORD=Rw5Knb3d91" \
  -e "SEAFILE_HOST=this.ismyhost.com" \
  -e "SEAFILE_PORT=8080" \
  -v "/this/will/be/your/data/path:/opt/seafile" \
  --name="seafile-init" \
  stratordev/seafile \
  /init

It will create everything needed interactively. When the command ends, everything is ready.

And then, you can use for each further starts :

sudo docker \
  run \
  -d \
  -v "/this/will/be/your/data/path:/opt/seafile" \
  -p 0.0.0.0:8080:8080 \
  --name="seafile" \
  stratordev/seafile

Upgrading

Upgrading is easy with this image.

1. Stop the seafile server (eg: docker stop seafile; docker rm -f -v seafile)
2. ⚠️ backup you data folder (/this/will/be/your/data/path in this page) ⚠️
3. Run the upgrade command (see below) and don't forget to specify SEAFILE_VERSION. It's always mandatory for upgrade while it's not for init.
4. Run again the seafile server (like you usually do, see the previous section)

The upgrade command:

sudo docker \
  run \
  -it \
  --rm=true \
  -e "SEAFILE_VERSION=6.0.5" \
  --name="seafile-upgrade" \
  -v "/this/will/be/your/data/path:/opt/seafile" \
  stratordev/seafile \
  /upgrade

⚠️ The upgrade process may ask you things as seafile's upgrade scripts seems to be made to run interactivly.

Launching garbage collector (GC)

As strange as it may look like, seafile doesn't doesn't clean itself it's delete data. You need to explicitely run garbage collection from time to time.

Steps:

1. Stop the seafile server (eg: docker stop seafile; docker rm -f -v seafile)
2. (optional) Run the GC tool with "dry run" (see below)
3. Run the GC tool (see below)
4. Run again the seafile server (like you usually do, see the section before the previous section)

The GC tool command:

sudo docker \
  run \
  -it \
  --rm=true \
  --name="seafile-clean" \
  -v "/this/will/be/your/data/path:/opt/seafile" \
  stratordev/seafile \
  /clean

You may want to see if all will be fine without changing anything before really launching the GC tool, so you may just launch it in "dry run" just before:

sudo docker \
  run \
  -it \
  --rm=true \
  --name="seafile-clean" \
  -v "/this/will/be/your/data/path:/opt/seafile" \
  stratordev/seafile \
  /clean --dry-run

Using crane as docker manager

If you're using crane as a docker manager tool, here is a crane.yaml that match the previous example (from the Init + classic run usage section)

containers:
    seafile-init:
        image: "stratordev/seafile"
        run:
            tty: true
            interactive: true
            rm: true
            volume:
                - "/opt/dockerstore/seafile:/opt/seafile"
            env:
                - "SEAFILE_VERSION=5.1.3"
                - "[email protected]"
                - "SEAFILE_ADMIN_PASSWORD=Rw5Knb3d91"
                - "SEAFILE_HOST=this.ismyhost.com"
                - "SEAFILE_PORT=28080"
            cmd: "/init"
    seafile-upgrade:
        image: "stratordev/seafile"
        run:
            tty: true
            interactive: true
            rm: true
            volume:
                - "/opt/dockerstore/seafile:/opt/seafile"
            env:
                - "SEAFILE_VERSION=6.0.5"
            cmd: "/upgrade"
    seafile-clean:
        image: "stratordev/seafile"
        run:
            tty: true
            interactive: true
            rm: true
            volume:
                - "/opt/dockerstore/seafile:/opt/seafile"
            entrypoint: "/clean"
    seafile:
        image: "stratordev/seafile"
        run:
            detach: true
            publish:
                - "28080:8080"
            volume:
                - "/opt/dockerstore/seafile:/opt/seafile"

You then just have to type the first time the command crane run seafile-init :

$ crane run seafile-init
[... lot of stuff ...]

----------------------------------------
Successfully created seafile admin
----------------------------------------

$ 

And then, each time you want to start/restart the server crane run seafile :

$ crane run seafile
Running container seafile ...
b07b11d881fb265a0d1922a74355d81b428517514c10ee084cfbbeeeffc39b4b
$ 

And that's it... Your seafile server is up and running.

Upgrading with crane

As the upgrade section mentionned, you should:

1. Stop the seafile server
2. ⚠️ backup you data folder ⚠️
3. Run the upgrade command
4. Run again the seafile server

So it becomes with crane:

$ crane stop seafile
Stopping container seafile ...
seafile
$ # DO YOU BACKUP HERE BY BACKUPING `/opt/dockerstore/seafile` or whatever you put in you `crane.yml` file.
$ crane run seafile-upgrade
Running container seafile-upgrade ...
[... lot of stuff ...]
$ crane run seafile
seafile
Running container seafile ...
181578da4252625c28d661e888517e5915c1592c61617c5245bb52a4258e483c

And that's it... Your seafile server is up and running with the new version.

⚠️ The upgrade process may ask you things as seafile's upgrade scripts seems to be made to run interactivly.

Launching garbage collector (GC) with crane

As the GC tool section mentionned, you should:

1. Stop the seafile server
2. (optional)
3. Run the GC script
4. Run again the seafile server

So it becomes with crane:

$ crane stop seafile
Stopping container seafile ...
seafile
$ # THE ABOVE LINE IS OPTIONAL
$ crane run seafile-clean --dry-run
Running container seafile-clean ...
[... lot of stuff ...]
$ crane run seafile-clean
Running container seafile-clean ...
[... lot of stuff ...]
$ crane run seafile
seafile
Running container seafile ...
181578da4252625c28d661e888517e5915c1592c61617c5245bb52a4258e483c

And that's it... Your seafile server is up and running with the GC tool passed ok.

Note: that can be scripted and cron-tabbed.

Related projects

• docker-seafile : A docker image for seafile server
• docker-seafile-client : A docker image for seafile client (interface less)
• seafile : The seafile project main page
• docker : The docker project