@@ -7,7 +7,6 @@ Additional Documentation
77------------------------
88
99- [ API] [ docs-api ]
10- - [ Deployment] [ docs-deployment ]
1110- [ Administration] [ docs-admin ]
1211
1312Database Configuration
@@ -108,6 +107,35 @@ $ docker push codingteam/loglist:$LOGLIST_VERSION
108107$ docker push codingteam/loglist:latest
109108```
110109
110+ Deployment
111+ ----------
112+
113+ To install the application from Docker, run the following command:
114+
115+ ``` console
116+ $ docker run -d --restart unless-stopped --name $NAME -v $CONFIG :/app/conf/application.conf --env-file $ENV_FILE --net host codingteam/loglist:$VERSION
117+ ```
118+
119+ Where
120+ - ` $NAME ` is the container name
121+ - ` $CONFIG ` is the ** absolute** path to the configuration file
122+ - ` $VERSION ` is the version you want to deploy, or ` latest ` for the latest
123+ available one
124+ - ` $ENF_FILE ` is the path to the env file (see ` docs/loglist.env ` for example)
125+
126+ For example, a production server may use the following settings (note this
127+ command uses the Bash syntax; adapt for your shell if necessary):
128+
129+ ``` bash
130+ NAME=loglist
131+ CONFIG=/opt/loglist/conf/application.conf
132+ VERSION=latest
133+ ENV_FILE=/opt/loglist/conf/loglist.env
134+ docker pull codingteam/loglist:$VERSION
135+ docker rm -f $NAME
136+ docker run -d --restart unless-stopped --name $NAME -v $CONFIG :/app/conf/application.conf --env-file $ENV_FILE --net host codingteam/loglist:$VERSION
137+ ```
138+
111139License
112140-------
113141
@@ -121,7 +149,6 @@ corresponding site section for further details.
121149
122150[ docs-admin ] : docs/Admin.md
123151[ docs-api ] : docs/API.md
124- [ docs-deployment ] : docs/Deployment.md
125152
126153[ docker-hub ] : https://hub.docker.com/r/codingteam/loglist
127154[ loglist ] : https://www.loglist.xyz/
0 commit comments