huginn icon indicating copy to clipboard operation
huginn copied to clipboard

Updates to your installation instructions!

Open NuclearMachine opened this issue 3 years ago • 0 comments

Hey! Thought your installation instructions could use some help. It's kind of confusing for both newcomers and experts.

It's also missing some key components:

  • Bundling will fail if the ruby version is v3 and above, there's no recommended version listed.
  • You can encounter a mimemagic build error while bundling are there are no notes for this.
  • If the user is using PostgreSQL, the user should change DATABASE_ADAPTER from the .env file versus prepending it with the commands.
  • There should be a reminder for updating the database username and password in the .env file.
  • Updating APP_SECRET_TOKEN is apparently a requirement however there are no instructions written for this.

Oh! And I also embedded a couple of video replays to provide context to newbies. They're hosted on replayable.io, a company that's sponsoring my contributions.

Let me know what you guys think!

NuclearMachine avatar Sep 08 '22 07:09 NuclearMachine