@@ -3,30 +3,45 @@ __A Free and Open Source Agnostic Game Panel__
### Usage ###
---
Docker: `docker run --name=pterodactyl-panel -p 80:80 -p 443:443 --env-file=./.env quay.io/ccarney/pterodactyl-panel:v0.6.0-rc.1`
Docker:
It is recommended to create a environment file and run the following command:
`docker run --name=pterodactyl-panel -p 80:80 -p 443:443 --env-file=./.env quay.io/ccarney/pterodactyl-panel:v0.6.0-rc.1`
__or__
Docker Compose: `docker-compose up`
Docker Compose:
Edit the environment section within docker-compose.yml then run `docker-compose up`
Please refer to ENVIRIONMENT.md for more information regarding environment variables.
### Docker Compose ###
---
This repo provides a template docker-compose.yml file for easier deployment for the panel. It is highly recommended to use over straight up Docker.
### Updating ###
---
__Minor Revisions & Configuration Changes:__
Docker: `docker run --rm -v <root>:/data --env-file=./.env quay.io/ccarney/pterodactyl-panel:v0.6.0 p:update`
Docker:
It is recommended to create a environment file and run the following command: `docker run --rm -v <root>:/data --env-file=./.env quay.io/ccarney/pterodactyl-panel:v0.6.0 p:update`
Docker Compose:
Docker Compose:`docker-compose run --rm panel p:update`
Edit the environment section within docker-compose.yml then run`docker-compose run --rm panel p:update`
__From v0.5.x to v0.6.x:__
*TBA...*
### Entrypoint Commands ###
* p:start - Starts the panel webserver and requirements (We don't provide Memcached!).
* p:update - Updates the panel config using environment variables on runtime.
### SSL Encryption ###
---
...
...
@@ -34,4 +49,14 @@ SSL Encryption is an optional but recommended feature. Automatic SSL is provided
### Contributing ###
---
All issues regarding Pterodactyl Panel/Node are to be reported to https://github.com/Pterodactyl/Panel/issues.
\ No newline at end of file
All issues regarding Pterodactyl Panel/Node are to be reported to https://github.com/Pterodactyl/Panel/issues.