rebuilding docker-compose.yml

.env.example

+# MySQL Settings, These can be deleted if you don't use docker-compose.other.yml
+MYSQL_ROOT_PASSWORD=apassword
+MYSQL_DATABASE=pterodactyl
+MYSQL_USER=ptero
+MYSQL_PASSWORD=pterodbpass
+
+# Please change this to something else or routing will not work correctly.
+APP_URL=http://localhost/
+
+# SSL Encryption, useful if you dont run behind a reverse proxy
+SSL=false
+SSL_CERT=/certs/live/localhost/fullchain.pem
+SSL_CERT_KEY=/certs/live/localhost/privkey.pem
+
+# Panel Variables, These are only needed when doing initial setup.
+# When doing migration, the container will attempt to get the environment
+# variables from the .env file.
+TIMEZONE=UTC
+
+CACHE_DRIVER=memcached
+
+# Rely on an external source so we can put the panel container down when updates are needed
+MEMCACHED_HOST=cache
+MEMCACHED_PORT=11211
+
+DB_HOST=mysql
+DB_PORT=3306
+DB_DATABASE=pterodactyl
+DB_USERNAME=ptero
+DB_PASSWORD=pterodbpass
+
+MAIL_DRIVER=mail
+MAIL_FROM=admin@localhost
+MAIL_FROM_NAME="Pterodactyl Panel"
\ No newline at end of file

.gitignore

 /data
 /db
+.env
+docker-compose.override.yml
\ No newline at end of file

README.md

@@ -5,20 +5,25 @@
 
 ----
 
-### Usage ###
+### Quick Start ###
+
+Copy .env.example as .env and run the setup under the commands provided:
 
 *Docker*:
 
-You can run the panel using this command: `docker run --name=pterodactyl-panel -p 80:80 -p 443:443 --env-file=./.env quay.io/ccarney/pterodactyl-panel:testing`. 
+   You can run the panel using this command: 
+`docker run --name=pterodactyl-panel -p 80:80 -p 443:443 --env-file=./.env quay.io/ccarney/pterodactyl-panel:testing`.
 
-It is recommended to create a .env file for variables.
+<sup>* This command alone does not provide the full environment for the panel. This is more or less a reference. If you wish to have a full environment, it is recommended to use the method below.</sup>
 
 __or__
 
 *Docker Compose*:
 
-A _docker-compose.yml_ file is provided for anyone who uses docker compose.
-You can start the panel by running `docker-compose up -d`; You can edit variables using the environment section within _docker-compose.yml_.
+&nbsp;&nbsp;&nbsp;A *docker-compose.yml* file is provided for anyone who uses docker compose.
+You can start the panel by running `docker-compose up -d`.
+
+&nbsp;&nbsp;&nbsp;*docker-compose.other.yml* provides mysql and the Let's Encrypt certbot services. If you want to use those services, you can symlink or copy it as *docker-compose.override.yml*. 
 
 ### The _/data_ Volume ###
 
@@ -36,7 +41,7 @@ Refer to https://docs.pterodactyl.io/ when updating to a newer version. `php art
 
 ### Migrating ###
 
-Refer to https://docs.pterodactyl.io/ for migrating. For users who are coming from a non dockerized setup, you can put it within the */data* volume and rename it as pterodactyl.conf. Once all set, start up the container environment.
+Refer to [https://docs.pterodactyl.io/](https://docs.pterodactyl.io/) for migrating. For users who are coming from a non dockerized setup, you can put it within the */data* volume and rename it as pterodactyl.conf. Once all set, start up the container environment.
 
 ### Entrypoint Commands ###
 
@@ -54,14 +59,15 @@ All issues regarding Pterodactyl Panel/Node are to be reported to https://github
 
 *Pterodactyl Project*:
 
-https://pterodactyl.io/
+[https://pterodactyl.io/](https://pterodactyl.io/)
 
-https://docs.pterodactyl.io/
+[https://docs.pterodactyl.io/](https://docs.pterodactyl.io/)
 
-https://github.com/Pterodactyl/
+[https://github.com/Pterodactyl/](https://github.com/Pterodactyl/)
 
 *Docker*:
 
-https://docs.docker.com/
+[https://docs.docker.com/](https://hub.docker.com/)
+
+[https://hub.docker.com/](https://hub.docker.com/)
 
-https://hub.docker.com/

docker-compose.other.yml

+##
+# Optional Services, Recommended to rename to docker-compose.override.yml
+##
+
+version: '2'
+services:
+
+##
+# On initial setup, run "docker-compose run --rm certbot certonly --webroot -w /le-webroot 
+# -d <domain>" to recieve a certificate
+##
+  certbot:
+    command: renew
+    image: certbot/certbot:v1.13.0
+    volumes:
+    - ./certs:/etc/letsencrypt
+
+##
+# If you rely on another MySQL/MariaDB instance, this can be safely removed.
+# Make sure to remove the dependency from the panel
+##
+  mysql:
+    env_file: .env
+    volumes:
+    - ./db:/var/lib/mysql
+    image: mariadb:10.1
+  panel:
+    depends_on:
+    - mysql
\ No newline at end of file

docker-compose.yml

@@ -10,31 +10,6 @@ services:
   cache:
     image: memcached:1.4-alpine
 
-##
-# If you want to encrypt your connection, it is recommended to remove comments and add a cronjob.
-# On initial setup, run "docker-compose run --rm certbot certonly --webroot -w /le-webroot 
-# -d <domain>" to recieve a certificate
-##
-#  certbot:
-#    command: renew
-#    image: certbot/certbot:v1.13.0
-#    volumes:
-#    - ./certs:/etc/letsencrypt
-
-##
-# If you rely on another MySQL/MariaDB instance, this can be safely removed.
-# Make sure to remove the dependency from the panel
-##
-  mysql:
-    environment:
-      - "MYSQL_ROOT_PASSWORD=apassword"
-      - "MYSQL_DATABASE=pterodactyl"
-      - "MYSQL_USER=ptero"
-      - "MYSQL_PASSWORD=pterodbpass"
-    volumes:
-    - ./db:/var/lib/mysql
-    image: mariadb:10.1
-
 ##
 # The main service.
 # Ensure that all variables/data is correct.
@@ -43,36 +18,7 @@ services:
     container_name: pterodactyl-panel
     depends_on:
     - cache
-    - mysql
-    environment:
-    # Please change this to something else or routing will not work correctly.
-    - APP_URL=http://localhost/
-
-    # SSL Encryption, useful if you dont run behind a reverse proxy
-    - SSL=false
-    - SSL_CERT=/certs/live/localhost/fullchain.pem
-    - SSL_CERT_KEY=/certs/live/localhost/privkey.pem
-
-    # Panel Variables, These are only needed when doing initial setup.
-    # When doing migration, the container will attempt to get the environment
-    # variables from the .env file.
-    - TIMEZONE=UTC
-
-    - CACHE_DRIVER=memcached
-
-    # Rely on an external source so we can put the panel container down when updates are needed
-    - MEMCACHED_HOST=cache
-    - MEMCACHED_PORT=11211
-
-    - DB_HOST=mysql
-    - DB_PORT=3306
-    - DB_DATABASE=pterodactyl
-    - DB_USERNAME=ptero
-    - DB_PASSWORD=pterodbpass
-
-    - MAIL_DRIVER=mail
-    - MAIL_FROM=admin@localhost
-    - MAIL_FROM_NAME="Pterodactyl Panel"
+    env_file: .env
     image: quay.io/ccarney/pterodactyl-panel:testing
     ports:
     - 80:80