Merge pull request #186 from danwdart/dockerise

Dockerise steps

Author: danwdart

.babelrc

@@ -0,0 +1,6 @@
+db
+info
+scripts
+servers/docker
+src/js/node_modules
+src/php/vendor

.dockerignore

@@ -0,0 +1,57 @@
+APPLICATION_ENV=development
+NODE_ENV=development
+
+EMAILS_PATH=/var/www/mustache/en_GB/mail
+UPLOADS_PATH=/var/www/public/uploads
+
+SQL_ADAPTER=pdo_mysql
+
+SQL_PASSWORD=testtest123
+SQL_USER=chaplin
+SQL_DATABASE=chaplin
+SQL_HOST=mysql
+SQL_PORT=3306
+
+AMQP_HOST=rabbitmq
+AMQP_PORT=5672
+AMQP_USER=root
+AMQP_PASSWORD=root
+AMQP_VHOST=/
+
+SMTP_HOST=smtp.gmail.com
+SMTP_USE_TLS=true
+SMTP_PORT=587
+SMTP_USER=
+SMTP_PASSWORD=
+
+# https://developer.vimeo.com/apps
+VIMEO_CLIENT_SECRET=
+VIMEO_CLIENT_ID=
+VIMEO_ACCESS_TOKEN=
+
+# https://console.developers.google.com/apis/credentials
+YOUTUBE_API_TOKEN=
+
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+
+FACEBOOK_CLIENT_ID=
+FACEBOOK_CLIENT_SECRET=
+
+TWITTER_CONSUMER_KEY=
+TWITTER_CONSUMER_SECRET=
+
+SCHEME=http
+VHOST=dev.projectchaplin.com
+VHOST_PORT=80
+VHOST_SHORT=pc
+VHOST_NODE=node.projectchaplin.com
+VHOST_NODE_PORT=80
+
+VHOST_GUI=dev.projectchaplin.com
+
+API_HOST=api
+API_PORT=9000
+
+NODE_HOST=node
+NODE_PORT=3000

.env.docker

@@ -0,0 +1,62 @@
+APPLICATION_ENV=development
+NODE_ENV=development
+
+EMAILS_PATH=/var/www/mustache/en_GB/mail
+UPLOADS_PATH=/var/www/public/uploads
+
+SQL_ADAPTER=pdo_mysql
+
+MYSQL_ROOT_PASSWORD=testtest123
+MYSQL_DATABASE=chaplin
+MYSQL_USER=chaplin
+MYSQL_PASSWORD=chaplin
+
+SQL_PASSWORD=${MYSQL_PASSWORD}
+SQL_USER=${MYSQL_USER}
+SQL_DATABASE=${MYSQL_DATABASE}
+SQL_HOST=mysql
+SQL_PORT=3306
+
+AMQP_HOST=rabbitmq
+AMQP_PORT=5672
+AMQP_USER=root
+AMQP_PASSWORD=root
+AMQP_VHOST=/
+
+SMTP_HOST=smtp.gmail.com
+SMTP_USE_TLS=true
+SMTP_PORT=587
+SMTP_USER=
+SMTP_PASSWORD=
+
+# https://developer.vimeo.com/apps
+VIMEO_CLIENT_SECRET=
+VIMEO_CLIENT_ID=
+VIMEO_ACCESS_TOKEN=
+
+# https://console.developers.google.com/apis/credentials
+YOUTUBE_API_TOKEN=
+
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+
+FACEBOOK_CLIENT_ID=
+FACEBOOK_CLIENT_SECRET=
+
+TWITTER_CONSUMER_KEY=
+TWITTER_CONSUMER_SECRET=
+
+SCHEME=http
+VHOST=dev.projectchaplin.com
+VHOST_PORT=80
+VHOST_SHORT=pc
+VHOST_NODE=node.projectchaplin.com
+VHOST_NODE_PORT=80
+
+VHOST_GUI=dev.projectchaplin.com
+
+API_HOST=api
+API_PORT=9000
+
+NODE_HOST=node
+NODE_PORT=3000

.env.example

@@ -8,3 +8,4 @@ npm-debug.log
 /public/js/*.woff*
 /public/js/*.eot
 /public/js/*.ttf
+.env

.gitignore

@@ -1,17 +1,20 @@
 # Project Chaplin
-an open source, self-hosted video sharing service
+
+An open source, self-hosted video sharing service
 
 ## Current features
 * AGPLv3 License
 * No intrusive adverts
 * No restrictions on content by country, IP or government
 * Video downloading as standard
 * HTML5 WebM as standard
-* Live streaming (pluginless)
 * Brightness/Contrast controls
 * Easter eggs?
+* [12-Factor App](https://www.12factor.net/)
+* Fully Docker service compatible
 
 ## Future features
+* Live streaming (pluginless) - to be re-implemented
 * No staff blocking, auto-blocking only on public demand
 * REST APIs
 * Public tagging
@@ -21,20 +24,38 @@ an open source, self-hosted video sharing service
 * Download audio
 * Scrape from other public APIs
 
-## Recommended way to install
-Try using Docker for a fast install:
+## Recommended way to install and run
+
+1. Copy over the special `/.env.docker` to `/.env` and edit environment variables as appropriate
+2. Use [Docker Compose](https://docs.docker.com/compose/) to install:
+
+`docker-compose -p chaplin -f servers/docker/docker-compose.yml up -d`
+
+3. Visit the site (http://localhost or add the vhost - by default http://dev.projectchaplin.com - to /etc/hosts).
 
-`docker run --link mysql:mysql --link redis:redis --link rabbitmq:rabbitmq -p 80:80 -p 1337:1337 -d --rm -v $PWD:/var/www kathiedart/projectchaplin`
+## Development on Docker
 
-This will install the dependencies and let you use your local pull as a volume. To upgrade at any time just git pull.
+Edits on the source repository will be propagated to the docker environment with this command instead of the above:
+
+`docker-compose -p chaplin -f servers/docker/docker-compose.dev.yml up -d`
+
+## Manual install
+
+- Copy over `/.env.example` to `/.env` and edit environment variables as appropriate
+- Check the Dockerfiles in `servers/docker` for installation instructions for each component.
+- Compile the client-side JS in `src/php` by using `npm install` and `npm run build`.
+- Ensure PHP has the bcmath, pdo and pdo_mysql (or whichever DB you use) extension.
+- Install the PHP in `src/php` by using `composer install`.
+- Install Nginx to serve PHP in `src/php/public`.
+- Run listeners in `src/php/cli/cli.php` like: `php cli.php cli youtube`, `php cli.php cli convert` and `php cli.php cli vimeo`.
+- Nginx configs are in `servers/nginx` and copy `servers/php-fpm/uploads.ini` to php-fpm's `conf.d`.
+- SQL schema is in `db/`.
+- Add appropriate hosts to `/etc/hosts` or use DNS.
 
 ## Join us!
 We are currently looking for developers and designers to help this open source project.
-If you're interested please contact me at chaplin@kathiedart.co.uk.
+If you're interested please contact me at chaplin@jolharg.com.
 
 ## Issues
 For help, you can create an issue on the Github project:
-https://github.com/kathiedart/projectchaplin/issues
-
-### Remember
-Have fun!
+https://github.com/danwdart/projectchaplin/issues