Add documentation about different docker images

Dominik Sander 8 年之前
父节点
当前提交
27adf10213
共有 4 个文件被更改,包括 21 次插入9 次删除
  1. 12 0
      docker/README.md
  2. 2 2
      docker/single-process/README.md
  3. 2 2
      docker/single-process/docker-compose.yml
  4. 5 5
      docker/single-process/postgresql.yml

+ 12 - 0
docker/README.md

@@ -0,0 +1,12 @@
1
+Huginn Docker images
2
+====================
3
+
4
+Huginn is packaged in two docker images.
5
+
6
+#### `cantino/huginn` multiple process image
7
+
8
+This image runs all processes needed by Huginn in one container, when not database is linked it will also start MySQL internally. It is great to try huginn without having to set up anything, however maintenance and backups can be difficult.
9
+
10
+#### `cantino/huginn-single-process` multiple container image
11
+
12
+This image runs just one process per container and thus needs at least two container to be started, one for the Huginn application server and one for the threaded background worker. It is also possible to every background worker in a separate container to improve the performance. See [the PostgreSQL docker-compose configuration](single-process/postgres.yml) for an example.

+ 2 - 2
docker/single-process/README.md

@@ -64,14 +64,14 @@ Manual startup and linking to a MySQL container:
64 64
         -e DATABASE_NAME=huginn \
65 65
         -e DATABASE_USERNAME=huginn \
66 66
         -e DATABASE_PASSWORD=somethingsecret \
67
-        dsander/huginn-single-process
67
+        cantino/huginn-single-process
68 68
 
69 69
     docker run --name huginn_threaded \
70 70
         --link huginn_mysql:mysql \
71 71
         -e DATABASE_NAME=huginn \
72 72
         -e DATABASE_USERNAME=huginn \
73 73
         -e DATABASE_PASSWORD=somethingsecret \
74
-        dsander/huginn-single-process /scripts/init bin/threaded.rb
74
+        cantino/huginn-single-process /scripts/init bin/threaded.rb
75 75
 
76 76
 ## Environment Variables
77 77
 

+ 2 - 2
docker/single-process/docker-compose.yml

@@ -13,7 +13,7 @@ mysql:
13 13
     MYSQL_PASSWORD: myhuginnpassword
14 14
 
15 15
 huginn_web:
16
-  image: dsander/huginn-single-process
16
+  image: cantino/huginn-single-process
17 17
   restart: always
18 18
   extends:
19 19
     file: environment.yml
@@ -24,7 +24,7 @@ huginn_web:
24 24
     - mysql
25 25
 
26 26
 huginn_threaded:
27
-  image: dsander/huginn-single-process
27
+  image: cantino/huginn-single-process
28 28
   restart: always
29 29
   extends:
30 30
     file: environment.yml

+ 5 - 5
docker/single-process/postgresql.yml

@@ -11,7 +11,7 @@ postgres:
11 11
     POSTGRES_USER: huginn
12 12
 
13 13
 huginn_web:
14
-  image: dsander/huginn-single-process
14
+  image: cantino/huginn-single-process
15 15
   restart: always
16 16
   extends:
17 17
     file: environment.yml
@@ -24,7 +24,7 @@ huginn_web:
24 24
     - postgres
25 25
 
26 26
 huginn_threaded:
27
-  image: dsander/huginn-single-process
27
+  image: cantino/huginn-single-process
28 28
   restart: always
29 29
   extends:
30 30
     file: environment.yml
@@ -36,7 +36,7 @@ huginn_threaded:
36 36
   command: /scripts/init bin/threaded.rb
37 37
 
38 38
 # huginn_schedule:
39
-#   image: dsander/huginn-single-process
39
+#   image: cantino/huginn-single-process
40 40
 #   extends:
41 41
 #     file: environment.yml
42 42
 #     service: huginn_base
@@ -48,7 +48,7 @@ huginn_threaded:
48 48
 
49 49
 
50 50
 # huginn_twitter_stream:
51
-#   image: dsander/huginn-single-process
51
+#   image: cantino/huginn-single-process
52 52
 #   extends:
53 53
 #     file: environment.yml
54 54
 #     service: huginn_base
@@ -60,7 +60,7 @@ huginn_threaded:
60 60
 
61 61
 
62 62
 # huginn_dj1:
63
-#   image: dsander/huginn-single-process
63
+#   image: cantino/huginn-single-process
64 64
 #   extends:
65 65
 #     file: environment.yml
66 66
 #     service: huginn_base