diff --git a/docs/ADDING_COMMUNITIES.md b/docs/ADDING_COMMUNITIES.md new file mode 100644 index 00000000..1c74984b --- /dev/null +++ b/docs/ADDING_COMMUNITIES.md @@ -0,0 +1,15 @@ +# Adding communities + +To add a community to your local + +## Notes + +This is only for local communities, not for remote communities. + +## Instructions + +1. Login to your instance as your admin user +2. Click the PieFed logo +3. Click **Explore communities** +4. In the top right hand corner, click the **Create local** button +5. Fill in the details \ No newline at end of file diff --git a/docs/ADDING_USERS.md b/docs/ADDING_USERS.md new file mode 100644 index 00000000..fd433ef8 --- /dev/null +++ b/docs/ADDING_USERS.md @@ -0,0 +1,41 @@ +# Adding users + +There are two ways of adding users to your instance to get the ball rolling. + +## Notes before starting + +Please note that both of these involve **local** users, and not **remote** users. + +## Instructions + +### Allow registration + +To allow registration: + +1. Login to your instance as your admin user +2. Go to **Admin** +3. Click on **Misc settings** +4. Look for **Registration mode**. +5. Either set the choice to **Open** or **Require Application** + +### Registering + +After registration is set to open/require application, the common user flow is to +navigate to your instance and click **Register**. + +### Disabling ReCAPCHA + +If you ensure your `.env` file has empty values for `RECAPTCHA3_PUBLIC_KEY` and +`RECAPTCHA3_PRIVATE_KEY`, then you can bypass the ReCAPCHA step. The only problem is +you will need to ensure the users email address is verified, and this may be a hassle. + +## Admin screen + +1. Login to your instance as your admin user +2. Go to **Admin** +3. Click **Users** +4. Click the **Add local user** button. +5. Fill in the details +6. Ensure you click **Email address is verified**. + +Once you've set all the details and save, the user is now accessible. \ No newline at end of file diff --git a/docs/KEY_TERMS.md b/docs/KEY_TERMS.md new file mode 100644 index 00000000..3986ba2c --- /dev/null +++ b/docs/KEY_TERMS.md @@ -0,0 +1,10 @@ +# Key terms + +* `Instance`: A single PieFed server. if you are developing on your local, it will most +likely be http://127.0.0.1:5000. Otherwise, if you have set up your instance, or for +whichever instance you want to apply (assuming you have the privileges for the +actions detailed) +* `Local`: By making changes on a local instance, any actions done will be done +* on that instance. +* `Remote`: By making changes on a local instance, any actions done will be applied +to an external instance. \ No newline at end of file