Minor documentation changes

This commit is contained in:
Simon Burns 2015-12-15 08:21:26 +00:00
parent 23e65c32b0
commit d02b81b2d7

View File

@ -4,20 +4,26 @@ Based on instructions here:
https://github.com/cantino/huginn/blob/master/doc/manual/installation.md https://github.com/cantino/huginn/blob/master/doc/manual/installation.md
I created this installation for Vagrant/VirtualBox because I couldn't get email Setup Huginn under VirtualBox, with minimal configuration required.
working from the Docker image.
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` - 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` - 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). (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 - Edit `provision.sh` and change the MySQL passwords for the root MySQL user and
the Huginn DB user (search for FIXME again). the Huginn DB user (search for FIXME again).
- Edit the `Vagrantfile` if you want to change the virtual machine settings. I've - 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 gone with `vb.memory = "1024"` which you might want to increase if you think
your Huginn needs more. your Huginn is going to be busier.
- You might want to change this line `config.vm.box = "ubuntu/trusty64"` if your - You might want to change the line `config.vm.box = "ubuntu/trusty64"` if your
PC can't run 64-bit images. PC can't run 64-bit images.
- Edit the `huginn` file if you want to change the listening address and port for - Edit the `huginn` file if you want to change the listening address and port for
your Huginn instance. your Huginn instance.