Troubleshooting tips

.github/workflows/bonfire.yaml

@@ -87,7 +87,7 @@ jobs:
       run: mix test
 
   test_cooperation_flavour:
-    name: Test coordination flavour
+    name: Test cooperation flavour
     runs-on: ubuntu-latest
     container: elixir:alpine
     env:

Makefile

@@ -51,18 +51,19 @@ endef
 pre-config: pre-init ## Initialise env files, and create some required folders, files and softlinks
 	@echo "You can now edit your config for flavour '$(FLAVOUR)' in config/$(MIX_ENV)/secrets.env, config/$(MIX_ENV)/public.env and ./config/ more generally."
 
+CONFIG_PATH=$(FLAVOUR_PATH)/config
 pre-init:
 	@echo "Setting flavour to $(FLAVOUR_PATH)"
-	@ln -sfn $(FLAVOUR_PATH)/config ./config
+	@ln -sf $(FLAVOUR_PATH)/config ./config
 	@mkdir -p data/
 	@ln -sf ../$(FLAVOUR_PATH) ./data/current_flavour
-	@mkdir -p config/prod
-	@mkdir -p config/dev
-	@touch config/deps.path
-	@cp -n config/templates/public.env config/dev/ | true
-	@cp -n config/templates/public.env config/prod/ | true
-	@cp -n config/templates/not_secret.env config/dev/secrets.env | true
-	@cp -n config/templates/not_secret.env config/prod/secrets.env | true
+	@mkdir -p $(CONFIG_PATH)/prod
+	@mkdir -p $(CONFIG_PATH)/dev
+	@touch $(CONFIG_PATH)/deps.path
+	@cp -n $(CONFIG_PATH)/templates/public.env $(CONFIG_PATH)/dev/ | true
+	@cp -n $(CONFIG_PATH)/templates/public.env $(CONFIG_PATH)/prod/ | true
+	@cp -n $(CONFIG_PATH)/templates/not_secret.env $(CONFIG_PATH)/dev/secrets.env | true
+	@cp -n $(CONFIG_PATH)/templates/not_secret.env $(CONFIG_PATH)/prod/secrets.env | true
 
 pre-run:
 	@mkdir -p forks/

docs/DEPLOY.md

@@ -27,9 +27,9 @@ $ cd bonfire
 
 2. The first thing to do is choosing what flavour of Bonfire you want to deploy (the default is `classic`), as each flavour has its own Docker image and config. 
 
-For example if you want to run the `coordination` flavour (you may want to use direnv or something similar to persist this):
+For example if you want to run the `cooperation` flavour (you may want to use direnv or something similar to persist this):
 
-`export FLAVOUR=coordination MIX_ENV=prod`
+`export FLAVOUR=cooperation MIX_ENV=prod`
 
 3. Once you've picked a flavour, run this command to initialise some default config (.env files which won't be checked into git):
 

docs/HACKING.md

@@ -23,9 +23,9 @@ $ cd bonfire
 
 - The first thing to do is choosing what flavour of Bonfire you want to hack on (the default is `classic`), as each flavour has its own config.
 
-For example if you want to run the `coordination` flavour:
+For example if you want to run the `cooperation` flavour:
 
-`export FLAVOUR=coordination`
+`export FLAVOUR=cooperation`
 
 - Once you've picked a flavour, run this command to initialise some default config (.env files which won't be checked into git):
 
@@ -210,7 +210,25 @@ make git.merge~%                    Draft-merge another branch, eg `make git-mer
 make git.conflicts                  Find any git conflicts in ./forks
 ```
 
-## What happens when I get this error?
+## Troubleshooting
+
+### EACCES Permissions Error
+
+If you get a permissions error when following any of the steps, run the following command and it should be fixed:
+
+```shell
+cd ~/bonfire && sudo chown -R yourusername:yourusername .
+```
+
+### Unable to access Postgres database
+
+If you are getting any `:nxdomain` errors, check if you have any firewalls that may be blocking the port on your system.
+
+For example, if you are running UFW (a lot of Linux distros do), run the following command to allow access to port 4000:
+
+```shell
+sudo ufw allow 4000
+```
 
 ### (Mix) Package fetch failed
 

nix/module.nix

@@ -96,8 +96,8 @@ in
         POSTGRES_SOCKET_DIR = lib.mkIf (dbSocketDir != null) dbSocketDir;
         HOSTNAME = hostname;
         WITH_DOCKER = "no";
-        FLAVOUR = "coordination";
-        BONFIRE_FLAVOUR = "flavours/coordination";
+        FLAVOUR = "cooperation";
+        BONFIRE_FLAVOUR = "flavours/cooperation";
       };
     };
   };

nix/package.nix

@@ -1,4 +1,4 @@
-{ pkgs, self, flavour ? "coordination" }:
+{ pkgs, self, flavour ? "cooperation" }:
 let
   beamPackages = with pkgs; beam.packagesWith beam.interpreters.erlang;
 in

nix/shell.nix

@@ -1,4 +1,4 @@
-{ pkgs, flavour ? "coordination" }:
+{ pkgs, flavour ? "cooperation" }:
 
 with pkgs;