New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Troubleshooting tips #109
Troubleshooting tips #109
Conversation
I added a few steps I had to take to get my install working on my Raspberry Pi, in hopes that someone in the future will find use in them
It seems that the name was changed at some point or something along those lines, so using coordination breaks the setup process.
Using symlinks in mkdir in the WSL refuses to work properly, but using this hacky workaround allows everything to work as expected. It has been tested on both Linux and Windows and it works as desired.
I didn't intend to push all the commits at once, the last two added on unexpectedly. Going to make a new PR with separate commits. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the PR! good stuff :)
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 . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe saying to run the chown in their bonfire directory, since not everyone would have it at ~/bonfire
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose it could be changed to cd bonfire
, since that is what the HACKING.md documentation says
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it in the new PR
pre-init: | ||
@echo "Setting flavour to $(FLAVOUR_PATH)" | ||
@ln -sfn $(FLAVOUR_PATH)/config ./config | ||
@ln -sf $(FLAVOUR_PATH)/config ./config |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you explain why the n
option was removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The n
option doesn't appear to serve any definitive purpose in this context, so I didn't see the need for it. It shouldn't matter if the link is treated like a file or not, the commands worked just as well for me on both operating systems without that flag
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs for -h
(alias of -n
): If the link_name or link_dirname is a symbolic link, do not follow it. This is most useful with the -f option, to replace a symlink which may point to a directory.
When switching flavours, this means that the link is recreated pointing to the new source dir (flavours/x/config).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright fair enough, thank you for explaining. I'll be sure to switch it back before making my next PR
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good idea
After the troubleshooting PR is merged I will open a new PR with the other changes, I am trying to keep the code separate so it is easier to follow the changes in the commit timeline |
Added some of the steps I had to take when getting my install working