Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/greyltc/docker-owncloud

Arch linux based docker container with owncloud
https://github.com/greyltc/docker-owncloud

Last synced: about 1 month ago
JSON representation

Arch linux based docker container with owncloud

Awesome Lists containing this project

README 

        
docker-owncloud

===============

__4 June 2016 Update:__ It looks to me like [some major thing just happend to ownCloud](http://fortune.com/2016/06/03/what-happened-to-owncloud/). Apparently a significant number of the core ownCloud devs have jumped ship and started a new cloud thingy called Nextcloud. I've made [a docker container](https://hub.docker.com/r/greyltc/nextcloud/) and [associated github repo](https://github.com/greyltc/docker-nextcloud) just like this one to follow nextcloud too. I'll keep supporting this project along side the new Nextcloud one until I can see a winner.



Simple to use Docker container with the latest stable ownCloud server release, complete with all the bells and whistles. This project is 100% transparent and trustable, every file in the resulting docker image is traceable and inspectable by following up the docker image depenancy tree which starts with [my Arch Linux base image](https://github.com/greyltc/docker-archlinux).



Please report any issues or improvement ideas to [the github issue tracker](https://github.com/greyltc/docker-owncloud/issues)  

Pull requests welcome! Let's work together!



Say thanks by adding a star [here](https://github.com/greyltc/docker-owncloud/) and/or [here](https://registry.hub.docker.com/u/l3iggs/owncloud/).



__Check out [the wiki](https://github.com/greyltc/docker-owncloud/wiki)__ for some stuff that I didn't include here because I thought the readme was getting too big. Feel free to add new content to the wiki as you see fit.



### Features

- __NEW FEATURE:__ Try the latest ownCloud daily build by using `l3iggs/owncloud:daily`

  - Probably you should report any issues you find here to [the official oc issue tracker](https://doc.owncloud.org/server/9.1/developer_manual//bugtracker/)

- Streamlined [Let's Encrypt](https://letsencrypt.org/) functionality built right in

  - This will fetch valid, trusted and free SSL certs for your domain and install them into the image!

  - Hurray for green lock icons!

- __Superfast__

  - Uses PHP7 with APCu and Zend OpCache for maximum performance

- Now with [image version tags](https://hub.docker.com/r/l3iggs/owncloud/tags/) corresponding to OwnCloud release versions

  - So you won't get unexpectedly upgraded and you can safely stay on an OC version you know is working for you

- Built in (optional) MySQL database server (faster than sqlite default)

  - Or specify your own pre-existing database server during setup

- Web GUI driven initial setup of user/password/database

- Based on Arch Linux ensuring __everything__ is cutting edge & up to date

- SSL (HTTPS) encryption works out-of-the-box

  - Tweaked for maximum security while maintaining compatibility

- Optionally enable automatic SSL certificate regeneration at runtime for maximum security

  - Or easily incorporate your own SSL certificates

- In-browser document viewing and editing ready (.odt, .doc, and .docx)

- In-browser media viewing ready (pretty much everything I think)

- Comes complete with all of the official ownCloud apps pre-installed:

 - Bookmarks

 - Calendar

 - Contacts

 - Documents

 - Gallery

- Or install your own 3rd party apps



### Usage



1. [**Install docker**](https://docs.docker.com/installation/)

1. **Download and start the owncloud server instance**  



  ```

docker run --name oc -p 80:80 -p 443:443 -d l3iggs/owncloud

```

  __NOTE:__ In case you have an outdated version of `l3iggs/owncloud` you can update it with `docker pull l3iggs/owncloud` before you run the server via the above `docker run...` command

1. **Access your ownCloud server**  

Point your web browser to __https://localhost/owncloud__

1. **Setup ownCloud**  

Follow the on-screen instructions to perform the initial setup of your server.

1. **[Optional] Harden security**  

This image comes complete with a self-signed ssl certificate already built in, so https access is ready to go out of the box. I've provided this pre-generated certificate for convienence and testing purposes only. It affords greatly reduced security (compared to using secret certificates) since the "private" key is not actually private; anyone can download this image and inspect the keys and then decrypt your ownCloud traffic (sniffing your login credentials for example). To make the ssl connection to this ownCloud server secure, you can:  

(A) provide your own (secret) ssl certificate files  

(B) use the script provided here to generate new, self-signed certificate files  

or  

(C) use the script provided here to fetch (free) certificates for your domain from the [Let's Encrypt project](https://letsencrypt.org/)  

All of these will provide equal security (since the encryption key will be kept secret) but (B) will result in browser warnings whenever somone visits your site since the web browser will likely not trust your self-generated and self-signed keys.



  ---

_For option (A) (providing your own SSL cert files):_  

  The Apache config file calls out the need for two files here: SSLCertificateFile and SSLCertificateKeyFile. You should have those before you start.

  Name your certificate file `fullchain.pem` and your key file `privkey.pem` and put them in a directory `~/sslCert` on your host machine, then run (also on your host machine):   



  ```

sudo chown -R root ~/sslCert

sudo chgrp -R root ~/sslCert  

sudo chmod 400 ~/sslCert/privkey.pem

```  

 Then insert the following into the docker startup command (from step 2. above) between `run` and `--name`:  



  ```

-v ~/sslCert:/root/sslKeys

```  



  ---

_For option (B) (using the built-in script to re-generate your own self-signed ssl certificate):_ 

  - The image includes a bash script (`/usr/sbin/setup-apache-ssl-key`) that generates new ssl cert files on command (and overwrites the pregenerated ones included in this image). You can use this script to regenerate a new SSL key anytime, on the fly. After starting the docker image as described above, run the following command:  

  ```

docker exec -it oc sh -c 'SUBJECT="/C=US/ST=CA/L=CITY/O=ORGANIZATION/OU=UNIT/CN=localhost" DO_SSL_SELF_GENERATION=true setup-apache-ssl-key'  

```

  - To have a new ssl certificate generated automatically _every time_ the image is started, insert the following into the docker startup command (from step 2. above) between `run` and `--name`:  

  ```

-e DO_SSL_SELF_GENERATION=true -e SUBJECT=/C=US/ST=CA/L=CITY/O=ORGANIZATION/OU=UNIT/CN=localhost

```

  The `SUBJECT` variable is actually optional here, but I put it in there to show how to change the generated certificate to your liking, especially important if you don't want your certificate to be for `localhost`  



  ---

_For option (C) (fetching a free, trusted cert from letsencrypt.org):_  

  For this to work, __this container must be reachable from the internet by visiting http://your.domain.tld__ (where "your.domain.tld" will obviously be unique to you). In fact, a Let's Encrypt robot will attempt to visit this address via port 80 to read files served up by the apache server in this container during the certificate fetching process to verify your ownership of the domain.  

  Start the docker image as described above, except you must specify your hostname: add `--hostname=your.domain.tld` between `run` and `--name`. Then once the container is running, issue the following command (substituting your proper email address):  

  ```

docker exec -it oc sh -c '[email protected] DO_SSL_LETS_ENCRYPT_FETCH=true setup-apache-ssl-key'  

```

  ~30 seconds later you should get a green lock in your browser when visiting your OC server at https://your.domain.tld/owncloud  

  Now save your newly fetched certificate files somewhere safe:

  ```

docker cp oc:/etc/letsencrypt/archive/your.domain.tld ~/letsencryptFor_your.domain.tld

```

  and next time you use docker to start your OC server container, use option (A) to feed your `.key` and `.crt` files into the image when it starts.  

  __NOTE:__ Let's Encrypt gives you a certificate that's valid for three months, afterwhich it needs to be renewed if you'd like to continue getting green locks in your browser. If you run the above `DO_SSL_LETS_ENCRYPT_FETCH=true setup-apache-ssl-key` command, and then you leave your server running without restarting for three months or longer, your certificate *should* be auto-renewed forever. If you restart the container, you'll probably need to re-issue the `DO_SSL_LETS_ENCRYPT_FETCH=true setup-apache-ssl-key` command again manually if you don't want your certificate to expire three months after you first fetched it.  

  __NOTE #2:__ Let's Encrypt has a strict rate limiting policy; it will only grant 5 certificates / 7 days / domain so be very careful with how often you issue the `DO_SSL_LETS_ENCRYPT_FETCH=true setup-apache-ssl-key` command above



1. **[Optional] Stop the docker-owncloud server instance**



  ```

docker stop oc

```

You can restart the container later with `docker start oc`

1. **[Optional] Delete the docker-owncloud server instance (after stopping it)**  



  ```

docker rm oc #<--WARNING: this will delete anything stored inside the container

```

1. **Profit.**



### Updating your ownCloud server in this container

Periodically new ownCloud server versions will be released. You should probably keep your server on whatever the latest stable version is. When a new update is released you'll see a banner appear across the top of the ownCloud web interface indicating that it's time to upgrade.  

You should follow [the official ownCloud instructions](https://doc.owncloud.org/server/9.0/admin_manual/maintenance/update.html) for updating your ownCloud server using the updater app built into this container. You'll need to change the permissions of some files in the container to allow them to be updated. I've tried to make this straightforward by including a script to manage the permissions for you. Before you run the updater app (as described in the official instructions), run `docker exec -it oc sh -c 'set-oc-perms upgrade'`. Then after you've completed the upgrade, set the permissions back to their "safer" default values like this: `docker exec -it oc sh -c 'set-oc-perms runtime'`.