Installing Helpy

Getting Started:

Helpy is designed for the modern cloud, and you should be able to be up and running within minutes by following these steps. There are a few recommended cloud hosting providers, but Helpy will run on almost any host, provided you have met the basic requirements:

• You have installed Ruby and Rails, Git, Postgres
• You will need an application server like Unicorn, Puma or Passenger. I recommend Nginx as well.
• There are now tutorials for CentOS 6.x and Ubuntu 14.04 for setting up from scratch.
• As of Helpy 1.0, ImageMagick is now required
• The fact is that Helpy will probably run fine on other configurations too, but until there are confirmed and tested tutorials, you should stick with the above stack.

Install Helpy on your Local System

Although not required, installing locally is highly recommended and will make it easier for you to customize things like settings, colors and logos to match your site identity. To begin, clone Helpy from the official repo to your local system:

git clone https://github.com/helpyio/helpy.git

NOTE: The default Helpy email address is [email protected] and the default password is 12345678

Running on another port in development

If you want to run local development on a port other than 80, for example port 3000, you need to edit the port in Caddyfile AND also add "3000":"3000" to the services: ports: section of docker-compose.yml

Install on Digital Ocean:

Digital Ocean is our recommended hosting provider as they offer inexpensive VPS systems and you can be up in minutes. See Digital Ocean: Installing Helpy On Digital Ocean