rewrite instructions for a self-contained dev env

.env.development

@@ -1,4 +1,6 @@
 LOCAL_DOMAIN=localhost
-DB_HOST=$(pwd)/data/postgres15
+
+DB_HOST=$(pwd)/data/postgres
 DB_USER=mastodon
-DB_NAME=mastodon_development
+DB_NAME=mastodon_dev
+REDIS_URL=redis://$(pwd)/data/redis/redis-dev.sock

.env.test

@@ -3,3 +3,8 @@ NODE_ENV=tests
 # Federation
 LOCAL_DOMAIN=cb6e6126.ngrok.io
 LOCAL_HTTPS=true
+
+DB_HOST=$(pwd)/data/postgres
+DB_USER=mastodon
+DB_NAME=mastodon_dev
+REDIS_URL=redis://$(pwd)/data/redis/redis-test.sock

SETUP.md

@@ -1,62 +1,117 @@
 # Setting up a dev environment
 
-## Assumptions
-
-You have a package manager, and your system is systemd-based.
-
 ## Prerequisites
 
-### Nodejs
+Mastodon development requires the following:
 
-Install nodejs via your package manager. We used v19.1.0 for this setup.
+- Ruby 3.0
+- Ruby gems:
+  - `bundler`
+  - `irb`
+  - `foreman`
+- NodeJS v18 (LTS)
+- NPM packages:
+  - `yarn`
+- Postgres
+- Redis
 
-### Ruby
+### macOS
 
-Install ruby via your package manager of choice.
+First, make sure you have Homebrew installed. Follow the instructions at
+[brew.sh](https://brew.sh).
 
-### Ruby Extras
+Run the following to install all necessary packages:
+```
+brew install ruby@3.0 foreman node yarn postgresql redis
+```
 
-Your distro may package `bundle` and `irb` in separate packages (Arch does). If they are, install them too.
+Ruby 3.0 is **keg-only** by default. Follow the instructions in the **Caveat**
-On Arch these are `ruby-bundler` and `ruby-irb`.
+to add it to your path.
 
-### PostGreSQL
+### Linux
 
-Install postgres via your package manager.
+We will assume that you know how to locate the correct packages for your distro.
+That said, some distros package `bundler` and `irb` separately. Make sure that
+you also install these.
 
-### Redis
+On Arch, you will need:
 
-Install redis via your package manager.
+- `ruby`
+- `ruby-bundler`
+- `ruby-irb`
+- `ruby-foreman`
 
-Enable and start the default `redis.service`
+### Windows
 
-## Setting up the Environment
+Unfortunately, none of the authors use Windows. Contributions welcome!
 
-In the following instructions, replace USER with your *nix user name.
+## Database
 
-1. Add yourself to the postgres group with `sudo usermod -a -G postgres USER`. You'll need to log out and back in to
+In the root of this repository, go through the following script:
-update your groups.
+```sh
-2. Navigate to the root of this repo.
+# Create a folder for local data
-2. Set up a local DB cluster with `pg_ctl -D data/postgres15 initdb -o '-U mastodon --auth-host=trust'`.
+mkdir -p data
-3. Add the line `unix_socket_directories='.'` to `data/postgres15/postgresql.conf`.
+
-4. Run the DB with `pg_ctl -D data/postgres15 start`.
+# Set up a local database
-5. Run `bundle config set --local path 'vendor/bundle`. This will store the all the ruby gems locally so that we can
+pg_ctl -D data/postgres initdb -o '-U mastodon --auth-host=trust'
-   avoid interfering with system config.
+
-6. Run `bundle install`.
+# Use the data/postgres folder for the DB connection unix socket
-7. Run `yarn install`.
+#
-8. Run `bundle exec rake db:setup`. If this fails, you can use `bundle exec rake db:reset` to forcibly regenerate it.
+# If you don't know what that means, it's just a way for Mastodon to communicate
+# with a database on the same machine efficiently.
+#
+# See: https://manpages.ubuntu.com/manpages/jammy/man7/unix.7.html
+echo 'unix_socket_directories = .' >> data/postgres/postgresql.conf
+
+# Start the database
+pg_ctl -D data/postgres start --silent
+```
+
+## Redis
+
+In the root of this repository, run the following:
+```sh
+# Start Redis
+redis-server ./redis-dev.conf
+
+# [Optional] Stop Redis
+kill "$(cat ./data/redis/redis-dev.pid)"
+```
+
+## Ruby
+
+```sh
+export RAILS_ENV=development
+
+# Bundle installs all Ruby gems globally by default, which might cause problems.
+bundle config set --local path 'vendor/bundle'
+
+# [Apple Silicon] If using macOS on Apple Silicon, run the following:
+# bundle config build.idn-ruby -- --with-idn-dir="$(brew --prefix libidn)"
+
+# Install dependencies using bundle (Ruby) and yarn (JS)
+bundle install
+yarn install
+
+# Setup the database using the pre-defined Rake task
+#
+# Rake is a command runner for Ruby projects. The `bundle exec` ensures that
+# we use the version of Rake that this project requires.
+bundle exec rake db:setup
+
+# [Optional] If that fails, run the following and try again:
+# bundle exec rake db:reset
+```
 
 ## Running Mastodon
 
-1. To make our lives easier, we'll use `foreman` to run the site, so use `gem install foreman`.
+1. Run `export RAILS_ENV=development NODE_ENV=development`.
-2. Run `export RAILS_ENV=development` and `export NODE_ENV=development`.
   a. Put these in your shell's .rc, or a script you can source if you want to skip this step in the future.
-3. Run `bundle exec rake assets:precompile`.
+2. Run `bundle exec rake assets:precompile`.
-  a. If this explodes, complaining about `Hash`, you'll need to `export NODE_OPTIONS=--openssl-legacy-provider`. Same
+  a. If this explodes, complaining about `Hash`, you'll need to `export NODE_OPTIONS=--openssl-legacy-provider`.
-     deal as the above.
+  b. After doing this, you will need to run `bundle exec rake assets:clobber` and then re-run
-  b. After doing this, you will need to `bundle exec rake assets:clobber` and then re-run
   `bundle exec rake assets:precompile`.
-4. Run `foreman start`
+3. Run `foreman start`
-
 
 # Updates/Troubleshooting
 

redis-dev.conf

@@ -0,0 +1,12 @@
+# This redis configuration is for development only
+
+daemonize yes
+
+dir ./data/redis
+pidfile ./data/redis/redis-dev.pid
+
+unixsocket ./data/redis/redis-dev.sock
+unixsocketperm 700
+
+# Disable TCP
+port 0