|
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+## Why run Huginn with docker
|
|
|
2
|
+
|
|
|
3
|
+You can play with or deploy Huginn inside of [docker](http://www.docker.io/).
|
|
|
4
|
+
|
|
|
5
|
+Getting Huginn up and running using docker is quick and painless once you have docker installed. The docker container is suitable for production and evaluation. Huginn uses environmental variables for configuration, so rather than having a .env file, the Docker container expects variables to be passed into the launch command.
|
|
|
6
|
+
|
|
|
7
|
+## Running the Container
|
|
|
8
|
+
|
|
|
9
|
+### Quick start to check out Huginn
|
|
|
10
|
+
|
|
|
11
|
+#### OSX GUI using Kitematic
|
|
|
12
|
+
|
|
|
13
|
+1. Download and install [Kitematic](https://www.docker.com/docker-kitematic)
|
|
|
14
|
+* Start Kitematic and search for `cantino/huginn`
|
|
|
15
|
+* Click `create` and wait for the container to be downloaded and booted
|
|
|
16
|
+* Click on the link icon next to 'WEB PREVIEW'
|
|
|
17
|
+* Log in to your Huginn instance using the username `admin` and password `password`
|
|
|
18
|
+
|
|
|
19
|
+#### OSX/Windows/Linux using docker machine
|
|
|
20
|
+
|
|
|
21
|
+1. Download [docker machine](https://docs.docker.com/machine/#installation) for your OS
|
|
|
22
|
+* Follow the installation instructions untill you can successfully run `docker ps`
|
|
|
23
|
+* Get the the IP of the VM running docker by running `docker-machine ls`
|
|
|
24
|
+* Start your Huginn container using `docker run -it -p 5000:5000 cantino/huginn`
|
|
|
25
|
+* Open Huginn in the browser [http://docker-machine ip:5000](http://<docker-machine ip>:5000)
|
|
|
26
|
+* Log in to your Huginn instance using the username `admin` and password `password`
|
|
|
27
|
+
|
|
|
28
|
+#### Linux
|
|
|
29
|
+
|
|
|
30
|
+1. Install docker using the [install instructions](https://docs.docker.com/installation/)
|
|
|
31
|
+* Start your Huginn container using `docker run -it -p 5000:5000 cantino/huginn`
|
|
|
32
|
+* Open Huginn in the browser [http://localhost:5000](http://localhost:5000)
|
|
|
33
|
+* Log in to your Huginn instance using the username `admin` and password `password`
|
|
|
34
|
+
|
|
|
35
|
+## Configuration and linking to a database container
|
|
|
36
|
+
|
|
|
37
|
+Follow the [instructions on the docker hub registry](https://registry.hub.docker.com/u/cantino/huginn/) on how to configure Huginn using environment variables and linking the container to an external MySQL or PostgreSQL database.
|
|
|
38
|
+
|
|
|
39
|
+### Other options:
|
|
|
40
|
+
|
|
|
41
|
+Other Docker options:
|
|
|
42
|
+
|
|
|
43
|
+* If you don't want to use the official repo, see also: https://registry.hub.docker.com/u/andrewcurioso/huginn/
|
|
|
44
|
+* If you'd like to run Huginn's web process and job worker process in separate containers, another option is https://github.com/hackedu/huginn-docker. It also uses Unicorn as the web server and serves precompiled assets.
|
Dominik Sander