Update deployment instructions

pull/298/head
Rick Carlino 2016-11-17 10:18:19 -06:00
parent 006dc61e36
commit 4dd5823654
1 changed files with 68 additions and 3 deletions

View File

@ -1,5 +1,5 @@
# Deployment
# Deployment to Dokku (cheaper)
0. Provision a fresh Ubuntu 16 server (we use DigitalOcean's "Ubuntu 16 docker" image).
* Make sure you have atleast 1gb.
@ -11,8 +11,8 @@
0. Give Dokku a place to store RSA keys: `ssh dokku@my_server_name storage:mount my_app_name /var/lib/dokku/data/keys:/keys`.
0. Create a databse: `ssh dokku@my_server_name mariadb:create my_db_name`
0. Link the DB: `ssh dokku@my_server_name mariadb:link my_db_name my_app_name`
0. Set ENV vars like `JS\_FILE\_URL` to real values:
* `ssh dokku@my_server_name config:set my_app_name DEVISE_SECRET=$(rake secret) JS_FILE_URL=//mycdn.org/farmbot-fronted.js API_HOST=yourdomain.com API_PORT=1234`
0. Set ENV vars to real values (full ENV var list is in README:
* `ssh dokku@my_server_name config:set my_app_name DEVISE_SECRET=$(rake secret) API_HOST=yourdomain.com API_PORT=1234`
0. Deploy the app: `git push dokku@my_server_name:my_app_name master `
0. (optional) If that didn't work, do this on the server and try pushing again:
* `dokku trace on` (sets dokku to debug mode).
@ -20,3 +20,68 @@
* `dokku config:set --global CURL_CONNECT_TIMEOUT=30`
0. Migrate the database: `ssh dokku@my_server_name run my_app_name rake db:setup`
0. Your API is ready to go! You probably need to deploy the MQTT server next.
# Deployment Using Heroku (easier)
WIP
# Setting up SSL
Install [Certbot](https://certbot.eff.org/).
Run `sudo certbot certonly --manual`
Wait until you see this message and **DO NOT CONTINUE**:
```
Make sure your web server displays the following content at
http://yourdomain.io/.well-known/acme-challenge/SOME-LONG-URL before continuing:
ya6k1edW38z-CopyThisValueNow!!!
```
Set the `ACME_SECRET` ENV var to the value shown above (yours will be different) and **restart your API process**.
Once you have restarted the API process, continue through the installer.
You should see this:
```
IMPORTANT NOTES:
- Congratulations! Your certificate and chain have been saved at
/etc/letsencrypt/live/yourdomain.io/fullchain.pem
```
**Heroku Users**: Run the following snippet to submit the certs to Heroku:
```
heroku certs:add /etc/letsencrypt/live/yourdomain.io/fullchain.pem /etc/letsencrypt/live/yourdomain.io/privkey.pem
```
Heroku will then give you instructions on which DNS records you must create.
**Dokku Users**: We haven't had a need for this yet, because we usually run Dokku on staging setups only. Please [raise an issue](https://github.com/FarmBot/farmbot-web-frontend/issues/new) to receive support.
# Renew SSL Certificates
1. Run `sudo certbot certonly --manual -d YOUR_DOMAIN_HERE`
2. Wait for this message:
```
Make sure your web server displays the following content at
http://staging.farmbot.io/.well-known/acme-challenge/3tFAi5c7tJK-UJu0LGFM0xFwSExRZqzZD60w1723wOo before continuing:
3tFAi5c7tJK-YOURS\_WILL\_BE\_DIFFERENT
```
3. Set the `ACME_SECRET` ENV var to the value shown above (yours will be different). Process restart may be required if you are not on Heroku!
```
- Congratulations! Your certificate and chain have been saved at
/etc/letsencrypt/live/staging.farmbot.io/fullchain.pem.
```
4. (Heroku users only) `sudo heroku certs:update /etc/letsencrypt/live/YOUR_DOMAIN_HERE/fullchain.pem /etc/letsencrypt/live/YOUR_DOMAIN_HERE/privkey.pem`