Readme updates based on setup feedback

forem / selfhost

Selfhost your Forem Community on your own infrastructure 🎉

https://www.forem.com/get-started/

GNU Affero General Public License v3.0

1.45k stars 175 forks source link

Readme updates based on setup feedback #33

Open andygeorge opened 3 years ago

andygeorge commented 3 years ago

After an internal walkthrough by @cmgorton, we have some feedback to make some things a little clearer in the setup docs:

[ ] add explicit pip3 install ansible step
[ ] add ssh-add step after ssh-keygen
[ ] separate the quick setup steps into macOS vs Linux
[ ] add notes to each provider that let you know where your Forem VM lives at (looking at you, AWS EC2)
[ ] add note about Digital Ocean "Authentication contexts" to make that clearer

cmgorton commented 3 years ago

After some feedback from Mac: On step 7 of Quickstart guide add a note: "If you use AWS, you will need to generate an RSA-based SSH key and save it to the file path ~/.ssh/id_rsa.pub"

This is mentioned in the AWS section but since people are working on step 7 before going to the Cloud providers some people are creating an ssh key and then seeing that they have to create a RSA-based one if they use AWS.

cmgorton commented 3 years ago

I created a pull request for the SSH section. https://github.com/forem/selfhost/pull/34

cmgorton commented 3 years ago

Did you want me to try to update any of the other things here @andygeorge or did you get it already?

I could probably do:

add note about Digital Ocean "Authentication contexts" to make that clearer
add notes to each provider that let you know where your Forem VM lives at (looking at you, AWS EC2)

andygeorge commented 3 years ago

@cmgorton if you're bored and want to knock those out, go for it! I am working on some other stuff at the moment, but will get to these ASAP.

leog commented 2 years ago

I would also suggest explaining the automated steps to register a domain in the cloud provider such as DigitalOcean where the domain name gets registered alongside DNS setup. It would be great if that part could be optional, as I have setup my domain to work with Cloudflare and I couldn’t make my self hosted Forem work without removing DigitalOcean domain setup due to that previous configuration I already had.