mirror of
https://codeberg.org/rimu/pyfedi
synced 2025-01-24 03:43:42 -08:00
Merge pull request 'Start writing documentation on how to use PieFed' (#141) from somoso/pyfedi:add-docs into main
Reviewed-on: https://codeberg.org/rimu/pyfedi/pulls/141
This commit is contained in:
commit
b1dfd02516
3 changed files with 66 additions and 0 deletions
15
docs/ADDING_COMMUNITIES.md
Normal file
15
docs/ADDING_COMMUNITIES.md
Normal file
|
@ -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
|
41
docs/ADDING_USERS.md
Normal file
41
docs/ADDING_USERS.md
Normal file
|
@ -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.
|
10
docs/KEY_TERMS.md
Normal file
10
docs/KEY_TERMS.md
Normal file
|
@ -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.
|
Loading…
Add table
Reference in a new issue