@jaspermayone/ruby-rails-template

Setup Guide

Initial Setup

After cloning this repository, follow these steps to configure your application:

1. Generate unique credentials:

   bin/regenerate-credentials

   This creates a secure master key and credentials file specific to your project.

2. Generate a Lockbox encryption key by running in the Rails console:

   Lockbox.generate_key

3. Generate an ARE Key by running

   bin/rails db:encryption:init

4. Generate a blind_index key by running

   openssl rand -hex 32

5. Add the generated keys to your credentials:

   rails credentials:edit

   Then insert the keys in this format (replace the replaceme's with generated creds):

    active_record_encryption:
      primary_key: REPLACEME
      deterministic_key: REPLACEME
      key_derivation_salt: REPLACEME
   
   lockbox:
     master_key: REPLACEME
   
   blind_index:
     master_key: REPLACEME

6. Replace all instances of "REPLACEMEWITHAPPNAME" with your actual application name.

7. Install dependencies:

   bundle install && bun install

Next Steps

You're ready to start development! Consider reviewing the following:

• Database configuration in config/database.yml
• Environment variables in .env.example (copy to .env for local development)
• Test suite setup with rails test

Additional Resources

• Lockbox Documentation
• Rails Credentials Guide