diff --git a/README.md b/README.md index 30bd21a..49ff10c 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,12 @@ Note: We recommend deleting your existing metrics data and re-importing to take ### First time setup -1. Setup dependencies, environment & database: `bin/setup` -2. Setup encrypted attributes support: `bin/rails db:encryption:init` -3. Create and add credentials `bin/rails credentials:edit` (use config/credentials.sample.yml as template) -4. Start web server and sidekiq workers with: `bin/dev` +1. Rename `.env.example` to `.env` and update redis path if needed. +1. Delete `config/credentials.yml.enc` +2. Create and add your own credentials `bin/rails credentials:edit` (use config/credentials.example.yml as template) +3. Setup encrypted attributes support: `bin/rails db:encryption:init` and add to credentials +4. Setup dependencies, environment & database: `bin/setup` +5. Start web server and sidekiq workers with: `bin/dev` Visit `localhost:4000` diff --git a/config/credentials.sample.yml b/config/credentials.example.yml similarity index 62% rename from config/credentials.sample.yml rename to config/credentials.example.yml index ec63c17..b92a7cc 100644 --- a/config/credentials.sample.yml +++ b/config/credentials.example.yml @@ -1,14 +1,15 @@ -# aws: -# access_key_id: 123 -# secret_access_key: 345 +# Generate with `bin/rails encryption:init` +active_record_encryption: + primary_key: # Required + deterministic_key: # Required + key_derivation_salt: # Required -# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies. development: - secret_key_base: + secret_key_base: # Required (generate with `bin/rails secret`) action_mailer: username: password: - email_from_address: + email_from_address: # Required sendgrid: api_key: cloudflare: @@ -17,11 +18,11 @@ development: secret_access_key: bucket: test: - secret_key_base: + secret_key_base: # Required action_mailer: username: password: - email_from_address: + email_from_address: # Required sendgrid: api_key: cloudflare: