intercity-next
intercity-next copied to clipboard
intercity
How to run Rails on IC - Documentation
Since we don't want to have platform specific defaults in IC, we should put this information in Platform specific documentation.
Maybe we can change this topic to a "How to run Rails on IC" issue and list all the steps we need to document for that?
Suggestions (these are all my current things that are undocumented or the UI is not telling me how to do things when hosting a basic web app)
- Add SECRET_KEY_BASE
- How to link + set up the Database connection
- How to configure the web runner (puma or else) via Procfile
Addition:
- Tweak Puma settings (our own Puma is a very large config for a simple server)
More specific to my previous comment:
- Make sure people use the correct number of threads/workers for Puma config. For instance, on a single-core system ($10 Digital Ocean Droplet) you must only configure 1 thread because it has one core.
Turns out, SECRET_KEY_BASE is not required, I believe the Heroku buildpack sets this value for us.
@michiels Would it make sense to also port the documentation you wrote on the website to the internal docs of IC?
@jvanbaarsen Definetely! Do you think it would be good to just use the same markdown from the site for in-app documentation and sync it some way?
@michiels Hm, We can see if the markdown works correctly. For me it is important that the documentation in IC itself is leading. So we have to create it here, and then sync (parts) to the website.
Do you have suggestions for how to do this?
@jvanbaarsen Let me port the documentation to this repo, then I'll write a script in the Jekyll site to keep it in sync