Setup documentation

[LeonMatthes]

User Story

As a HART administrator
I want to have the setup steps for HART documented
in order to be able to set HART up on my own

Acceptance Criteria:

• A wiki page exists for how to setup HART
• The page contains information about how to create the first admin
• how to create the database
• how to configure the git ssh
• how to setup OAuth

[krichly]

• how to configure the hpi openid identity provider (I can write this section)

[chrisma]

Include instructions for local production deployment

• rails db:setup
• rails assets:precompile
• RAILS_SERVE_STATIC_FILES=true (https://stackoverflow.com/questions/16296671/asset-precompilation-ok-but-404-when-trying-to-get-files)
• localhost:3000 OIDC client from https://oidc.hpi.de/ (client ID b8853a32-074e-4853-89b1-747cd176a775, client secret f15d4e87ec376db6ed2f31f8f2dbcdf70ce62c0c72510268172320ac3ffe1c7967511aa3438bf6e5c188b4caf4a6c57a17dcc7421b661f71495746b2bf584584)
• Retrieve / build a master.key
• Retrieve / build a config/environment_variables.yml

[bdaase]

@chrisma @krichly The Setup page can be found here: https://github.com/hpi-swt2/vm-portal/wiki/HART-Setup.

It would be great if you could add your sections there.

[bdaase]

What exactly was the idea with

how to create the database

?

[chrisma]

What exactly was the idea with "how to create the database" ?

I would assume the steps necessary to create a db from scratch, i.e. rails db:setup, which calls schema:load and db:seed (https://github.com/rails/rails/blob/master/activerecord/lib/active_record/railties/databases.rake#L223)

[chrisma]

I could also imagine a small custom rake task (https://guides.rubyonrails.org/command_line.html#custom-rake-tasks) could be useful for the "Create the first admin" task, which promotes an existing user to admin and ignores problems with git.

$ bin/rails setup:create_admin

Only one user was found: '[email protected]'
Should this user be made admin? [Y/n]