From d02b81b2d7c413491437fd3848db21c814159850 Mon Sep 17 00:00:00 2001 From: Simon Burns Date: Tue, 15 Dec 2015 08:21:26 +0000 Subject: [PATCH] Minor documentation changes --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e00efe5..01debc6 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,26 @@ Based on instructions here: https://github.com/cantino/huginn/blob/master/doc/manual/installation.md -I created this installation for Vagrant/VirtualBox because I couldn't get email -working from the Docker image. +Setup Huginn under VirtualBox, with minimal configuration required. + +If you know the settings you will use for your Huginn installation (such +as SMTP host, MySQL settings, etc) you can: + +- Clone this repository: `git clone https://github.com/m0nty/huginn-vagrant.git` +- Jump straight in with `./setup.sh` and follow the prompts. No attempt + is made to validate your input while you do this. + +If you prefer to edit the config files yourself: - Clone this repository: `git clone https://github.com/m0nty/huginn-vagrant.git` -- Either use ./setup.sh for semi-automatic configuration via a dialog interface. - (If you do this, skip down to the line about config.vm.box below.) Or ... - Edit the `env` file, which will be copied to `/home/huginn/huginn/.env` (look for the FIXME comments in the file to see what you need to adjust). - Edit `provision.sh` and change the MySQL passwords for the root MySQL user and the Huginn DB user (search for FIXME again). - Edit the `Vagrantfile` if you want to change the virtual machine settings. I've gone with `vb.memory = "1024"` which you might want to increase if you think - your Huginn needs more. -- You might want to change this line `config.vm.box = "ubuntu/trusty64"` if your + your Huginn is going to be busier. +- You might want to change the line `config.vm.box = "ubuntu/trusty64"` if your PC can't run 64-bit images. - Edit the `huginn` file if you want to change the listening address and port for your Huginn instance.