From 066be0f3d446169661c692ce7a16815e1b96f9bb Mon Sep 17 00:00:00 2001
From: Sebastian Rakel <sebastian@devunit.eu>
Date: Tue, 26 Apr 2016 11:03:06 +0200
Subject: Add Dockerfile and scripts to create and run a docker container

---
 docker/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 docker/README.md

(limited to 'docker/README.md')

diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 000000000..d6b4af480
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,31 @@
+# Filebin Docker Container
+
+## Filebin
+Filebin is a paste service developed by Florian Pritz [https://paste.xinu.at/](https://paste.xinu.at/)
+
+## Dockerfile
+[Dockerfile](https://git.server-speed.net/users/flo/filebin/tree/docker/Dockerfile)
+
+## Ports
+The PHP webserver is listening on ```8080```
+
+## Volumes
+
+- **Uploaded Data:** uploaded files are saved to ```/var/lib/filebin/data/uploads```
+- **Advanced Configuration:** the configuration is located at ```/var/lib/filebin/application/config```
+
+## Environment Variables
+- **FB_DB_HOSTNAME:** the hostname of the mysql/mariadb server
+- **FB_DB_USERNAME:** the username for the mysql/mariadb server
+- **FB_DB_PASSWORD:** the password for the mysql/mariadb server
+- **FB_DB_DATABSE:** the database on the mysql/mariadb for Filebin
+
+- **FB_CONTACT_NAME:** Contact Name
+- **FB_CONTACT_MAIL:** Contact E-Mail (will be used as email for the first user)
+
+## First User
+The first user is **admin** with the password **admin**
+
+## Run
+### with linked mysql/mariadb database server
+```docker run -ti --rm -p <port>:8080 --link mdb:mysql  -e FB_DB_HOSTNAME=mysql -e FB_DB_USERNAME=filebin_usr -e FB_DB_PASSWORD=test -e FB_DB_DATABASE=filebin -e FB_CONTACT_NAME="John Doe" -e FB_CONTACT_MAIL="john.doe@localmail.local"  sebastianrakel/filebin```
-- 
cgit v1.2.3-24-g4f1b