Skip to content

Commit f0be264

Browse files
committed
Clarified self-hosted section of DEPLOY.md
Reformatted steps to be easier to read and more consistent with the other sections. Added username/password keys to example database.yml. Added config.serve_static_assets section. Added default user/password info from above since it's easy to miss.
1 parent 0fe77ee commit f0be264

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

DEPLOY.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -65,26 +65,37 @@ Looking for community help here.
6565
## Heroic server install
6666
If you're looking to install Kandan on a private server, or to develop locally for lemonodor fame, then here is the path you must follow, young hero:
6767

68-
For development-mode
68+
For development-mode
6969

7070
`sudo apt-get install nodejs` # (execjs needs an execution environment)
7171
`gem install execjs` # (Could possibly be added to the gemfile in the assets group)
7272

73-
Get the new gems:
73+
Install the required gems:
7474

7575
`bundle install`
7676

77-
Use the default database.yml to get started - you'll need to edit config/database.yml for *production* - you'll need to add something like this:
77+
You can use the default database.yml to get started in development. For production you'll need to edit config/database.yml to add something like this:
7878

7979
production:
8080
adapter: postgresql
8181
host: localhost
82-
database: kandan_development
82+
database: kandan_production
8383
pool: 5
8484
timeout: 5000
85+
# You might need these depending on your Postgres auth setup.
86+
username: kandan
87+
password: something
8588

86-
Now, bootstrap the install
89+
Now, bootstrap the install (you can omit the db:create step if you have already created the DB referenced above):
90+
8791
`bundle exec rake db:create db:migrate kandan:bootstrap`
88-
`bundle exec thin start`
8992

93+
If you plan to serve the app directly from Thin (rather than through a proxy), you will need to configure Rails to serve assets in the production environment. In config/environments/production.rb:
94+
95+
config.serve_static_assets = true
9096

97+
Start the server
98+
99+
`bundle exec thin start`
100+
101+
Your app should be up and running now. The default admin user is `Admin` with password `kandanappadmin`, or you can sign up as another user.

0 commit comments

Comments
 (0)