Readme.
parent
c258e0b85c
commit
2defcdc633
23
README.md
23
README.md
|
@ -4,8 +4,29 @@
|
||||||
|
|
||||||
*Automatic:*
|
*Automatic:*
|
||||||
|
|
||||||
|
You can click the button below to automatically deploy Snipt to Heroku.
|
||||||
|
|
||||||
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/nicksergeant/snipt/tree/heroku)
|
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/nicksergeant/snipt/tree/heroku)
|
||||||
|
|
||||||
|
*Please note:* this method will work fine, but you will not have email support
|
||||||
|
unless you manually configure Postmark. You don't necessarily need this,
|
||||||
|
though. After deploying the instance, visit
|
||||||
|
`https://<your-instance-name>/signup`, and create a user. You will get a 500
|
||||||
|
Server Error, which is the site trying to send a welcome email. Ignore the
|
||||||
|
error and go to `<https://your-instance-name>/login`, and log in with the
|
||||||
|
username and password you provided. Snipt will work fine, but you will not
|
||||||
|
receive any emails if there are server errors.
|
||||||
|
|
||||||
|
If you would like to configure your instance to use a free Postmark addon, do
|
||||||
|
the following after deploying:
|
||||||
|
|
||||||
|
- `git clone https://github.com/nicksergeant/snipt.git`
|
||||||
|
- `cd snipt`
|
||||||
|
- `heroku git:remote -a <your-instance-name>`
|
||||||
|
- `heroku addons:create postmark:10k`
|
||||||
|
- `heroku addons:open postmark` -> use an email you control and confirm it
|
||||||
|
- `heroku config:add POSTMARK_EMAIL=<email_from_above>`
|
||||||
|
|
||||||
*Manual:*
|
*Manual:*
|
||||||
|
|
||||||
- Clone the repo.
|
- Clone the repo.
|
||||||
|
@ -13,7 +34,7 @@
|
||||||
- `heroku addons:add heroku-postgresql:hobby-dev`
|
- `heroku addons:add heroku-postgresql:hobby-dev`
|
||||||
- `heroku addons:add searchbox`
|
- `heroku addons:add searchbox`
|
||||||
- `heroku addons:create postmark:10k`
|
- `heroku addons:create postmark:10k`
|
||||||
- `heroku addons:open postmark` -> use an email you control
|
- `heroku addons:open postmark` -> use an email you control and confirm it
|
||||||
- `heroku config:add POSTMARK_EMAIL=<email_from_above>`
|
- `heroku config:add POSTMARK_EMAIL=<email_from_above>`
|
||||||
- `heroku config:add SECRET_KEY=`
|
- `heroku config:add SECRET_KEY=`
|
||||||
- `git push heroku`
|
- `git push heroku`
|
||||||
|
|
Loading…
Reference in New Issue