Update 'docker-README.md'
This commit is contained in:
parent
92325b1743
commit
e8bef30c0b
|
@ -1,22 +1,16 @@
|
|||
# 🐳 Docker Compose for Development
|
||||
|
||||
```sh
|
||||
cd dev/
|
||||
docker-compose build
|
||||
docker-compose run --rm web yarn run init
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
# Running a Calckey instance with Docker
|
||||
# 🐳 Running a Calckey instance with Docker
|
||||
|
||||
## Pre-built docker container
|
||||
[thatonecalculator/calckey](https://hub.docker.com/r/thatonecalculator/calckey)
|
||||
## docker-compose
|
||||
You can find a `docker-compose.yml` file in the same folder as this `README`, along with a folder called `.config` containing two **example** files needed to get the instance running:
|
||||
|
||||
## `docker-compose`
|
||||
|
||||
There is a `docker-compose.yml` in the root of the project that you can use to build the container from source
|
||||
|
||||
- .config/docker.env (**db config settings**)
|
||||
- .config/default.yml (**calckey instance settings**)
|
||||
|
||||
## configuring calckey
|
||||
## Configuring
|
||||
|
||||
Rename the files:
|
||||
|
||||
|
@ -33,6 +27,7 @@ You can configure `docker.env` with anything you like, but you will have to pay
|
|||
Everything else can be left as-is.
|
||||
|
||||
## Running docker-compose
|
||||
|
||||
The [prebuilt container for calckey](https://hub.docker.com/r/thatonecalculator/calckey) is fairly large, and may take a few minutes to download and extract using docker.
|
||||
|
||||
Copy `docker-compose.yml` and the `config/` to a directory, then run the **docker-compose** command:
|
||||
|
@ -42,5 +37,11 @@ NOTE: This will take some time to come fully online, even after download and ext
|
|||
|
||||
Once the instance is up you can use a web browser to access the web interface at `http://serverip:3000` (where `serverip` is the IP of the server you are running the calckey instance on).
|
||||
|
||||
## Securing your instance with a reverse proxy
|
||||
On its own *calckey* serves itself with HTTP, and does not support SSL. In order to support encrypted connections via HTTPS - an absolute necessity if you intend to host an instance accessible from the public internet - you need to add a reverse proxy to your setup.
|
||||
## Docker for development
|
||||
|
||||
```sh
|
||||
cd dev/
|
||||
docker-compose build
|
||||
docker-compose run --rm web yarn run init
|
||||
docker-compose up -d
|
||||
```
|
Loading…
Reference in New Issue