forked from fonoster/fonoster
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docker): add examples of running docker commands
- Loading branch information
Showing
1 changed file
with
89 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,91 @@ | ||
| # Docker-backed infrastructure | ||
|
|
||
| Docker-backed infrastructure management for the Fonoster application stack. | ||
| > Docker-backed infrastructure management for the Fonoster application stack. | ||
| The easiest way to start running your Fonoster server is with our docker-in-docker (dind) installer. | ||
| Before running the installation command, make sure you have Docker Engine installed on your machine: | ||
|
|
||
| #### Install (Happy path) | ||
|
|
||
| Install application with the latest version available. | ||
|
|
||
| ```bash | ||
| docker run -it --rm \ | ||
| -e CONFIG_PATH=$(pwd)/fonoster/config \ | ||
| --volume /var/run/docker.sock:/var/run/docker.sock \ | ||
| --volume $(pwd)/fonoster:/out:rw \ | ||
| --entrypoint="/install.sh" \ | ||
| fonoster/fonoster | ||
| ``` | ||
|
|
||
| #### Install (With extra services) | ||
|
|
||
| Install application with the latest version and add additional services. | ||
|
|
||
| ```bash | ||
| docker run -it --rm \ | ||
| -e CONFIG_PATH=$(pwd)/fonoster/config \ | ||
| -e EXTRA_SERVICES=secrets,fs \ | ||
| --volume /var/run/docker.sock:/var/run/docker.sock \ | ||
| --volume $(pwd)/fonoster:/out:rw \ | ||
| --entrypoint="/install.sh" \ | ||
| fonoster/fonoster | ||
| ``` | ||
|
|
||
| #### Install (Passing version) | ||
|
|
||
| Install the app with the provided version. | ||
|
|
||
| ```bash | ||
| docker run -it --rm \ | ||
| -e CONFIG_PATH=$(pwd)/fonoster/config \ | ||
| -e EXTRA_SERVICES=secrets,fs \ | ||
| -e FONOSTER_VERSION=0.3.3 \ | ||
| --volume /var/run/docker.sock:/var/run/docker.sock \ | ||
| --volume $(pwd)/fonoster:/out:rw \ | ||
| --entrypoint="/install.sh" \ | ||
| fonoster/fonoster | ||
| ``` | ||
|
|
||
| #### Install (Verbose mode) | ||
|
|
||
| Display all logs of each process or command. | ||
|
|
||
| ```bash | ||
| docker run -it --rm \ | ||
| -e CONFIG_PATH=$(pwd)/fonoster/config \ | ||
| -e VERBOSE=true \ | ||
| -e FONOSTER_VERSION=0.3.3 \ | ||
| --volume /var/run/docker.sock:/var/run/docker.sock \ | ||
| --volume $(pwd)/fonoster:/out:rw \ | ||
| --entrypoint="/install.sh" \ | ||
| fonoster/fonoster | ||
| ``` | ||
|
|
||
| #### Update (Happy path) | ||
|
|
||
| Update your current installation to the latest patch for your current version. (e.g. 0.3.0 => 0.3.3) | ||
|
|
||
| ```bash | ||
| docker run -it --rm \ | ||
| -e CONFIG_PATH=$(pwd)/fonoster/config \ | ||
| --volume /var/run/docker.sock:/var/run/docker.sock \ | ||
| --volume $(pwd)/fonoster:/out:rw \ | ||
| --entrypoint="/update.sh" \ | ||
| fonoster/fonoster | ||
| ``` | ||
|
|
||
| #### Update (Passing version and verbose) | ||
|
|
||
| Update your current installation to the provided version. (if it's the same version with different patches) | ||
|
|
||
| ```bash | ||
| docker run -it --rm \ | ||
| -e CONFIG_PATH=$(pwd)/fonoster/config \ | ||
| -e FONOSTER_VERSION=0.3.3 \ | ||
| -e VERBOSE=true \ | ||
| --volume /var/run/docker.sock:/var/run/docker.sock \ | ||
| --volume $(pwd)/fonoster:/out:rw \ | ||
| --entrypoint="/update.sh" \ | ||
| fonoster/fonoster | ||
| ``` |