Browse Source

restaure README from master after merge and fixes

Bastien Sevajol 6 years ago
parent
commit
fce62e6386
1 changed files with 14 additions and 38 deletions
  1. 14 38
      README.md

+ 14 - 38
README.md View File

100
 
100
 
101
 ## Docker ##
101
 ## Docker ##
102
 
102
 
103
-**Important:** docker images is for local usage. If you want to use Tracim from network device, its necessary to change some lines in Development.ini file and build new image.
103
+In case you prefer using Docker:
104
 
104
 
105
-
106
-* For windows:
107
-
108
-Install [docker toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/)
109
-
110
-
111
-* For linux:
112
-
113
-You need to install docker on your server first.
114
-Example on Debian: `sudo apt-get install docker docker-compose`
105
+You need to install docker on your server first (see [here for debian](https://docs.docker.com/install/linux/docker-ce/debian/) or [here for windows]([docker toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/)))
115
 
106
 
116
 Make sure `docker.service` is started correctly.
107
 Make sure `docker.service` is started correctly.
117
-exemple on Debian: `sudo systemctl status docker`
118
 
108
 
119
-**If you want to use the latest stable image: **
109
+    systemctl status docker.service
120
 
110
 
121
-    sudo docker run -e DATABASE_TYPE=sqlite \
122
-               -p 80:80 -p 3030:3030 -p 5232:5232 \
123
-               -v /var/tracim/etc:/etc/tracim -v /var/tracim/var:/var/tracim algoo/tracim
111
+Then use image like following (adapt volume paths or ports as you want):
124
 
112
 
125
-**For another case, you can find exemple here:**
113
+    sudo docker run \
114
+        -e DATABASE_TYPE=sqlite \
115
+        -p 80:80 \
116
+        -p 3030:3030 \
117
+        -p 5232:5232 \
118
+        -v /var/tracim/etc:/etc/tracim \
119
+        -v /var/tracim/var:/var/tracim \
120
+        algoo/tracim  # docker image: tracim:unstable for development version, tracim_test:latest for nightly builds
126
 
121
 
127
-* You can use `algoo/tracim:<$tag>` stable image (replace `<$tag>` by the tag you want to use):
128
 
122
 
129
-        sudo docker run -e DATABASE_TYPE=sqlite \
130
-               -p 80:80 -p 3030:3030 -p 5232:5232 \
131
-               -v /var/tracim/etc:/etc/tracim -v /var/tracim/var:/var/tracim algoo/tracim:<$tag>
123
+All docker images are available here : https://hub.docker.com/u/algoo/
124
+More information about build docker image: https://github.com/tracim/docker_tracim
132
 
125
 
133
 Description of versioning:
126
 Description of versioning:
134
 
127
 
137
 * algoo/`tracim_testing:latest` is a latest image from branch develop
130
 * algoo/`tracim_testing:latest` is a latest image from branch develop
138
 * algoo/`tracim:unstable` is a latest unstable image from branch develop
131
 * algoo/`tracim:unstable` is a latest unstable image from branch develop
139
 
132
 
140
-More information about command:
141
-
142
-    sudo docker run \
143
-        -e DATABASE_TYPE=sqlite \   # define database: may be sqlite, mysql, postgresql
144
-        -p 80:80 \  # web server port mapping
145
-        -p 3030:3030 \  # webdav interface port mapping
146
-        -p 5232:5232 \  # caldav interface port mapping
147
-        -v /var/tracim/etc:/etc/tracim \ # config file storage path
148
-        -v /var/tracim/var:/var/tracim \  # file storage path
149
-        algoo/tracim:unstable  # docker image: tracim:unstable for development version, tracim_test:latest for nightly builds
150
-
151
-
152
-
153
-All docker images are available here : https://hub.docker.com/u/algoo/
154
-More information about build docker image: https://github.com/tracim/docker_tracim
155
-
156
-
157
 ----
133
 ----
158
 
134
 
159
 ## Install Tracim on your server ##
135
 ## Install Tracim on your server ##