Skip to content

Commit a333540

Browse files
dansupdansup
committed
Update docs
1 parent 51b408f commit a333540

File tree

5 files changed

+106
-3
lines changed

5 files changed

+106
-3
lines changed

‎.vitepress/config.mjs

+7
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ export default defineConfig({
2727
i18nRouting: false,
2828

2929
sidebar: [
30+
{
31+
text: '',
32+
items: [
33+
{ text: 'Introduction', link: '/project/introduction' },
34+
{ text: 'Community', link: '/project/community' },
35+
]
36+
},
3037
{
3138
text: 'Running Pixelfed',
3239
items: [

‎index.md

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ hero:
88
tagline: "The official Pixelfed documentation"
99
actions:
1010
- theme: brand
11+
text: Introduction
12+
link: /project/introduction
13+
- theme: alt
1114
text: Installation Guide
1215
link: /running-pixelfed/prerequisites
1316
- theme: alt

‎project/community.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Community
2+
3+
## Chat
4+
5+
We maintain a public Discord and Matrix channel.
6+
7+
> Before interacting, please read through the [Code Of Conduct](https://github.com/pixelfed/pixelfed/blob/dev/CODE_OF_CONDUCT.md).
8+
9+
- [Discord](https://discord.gg/MHvDHaSzmc)
10+
- [Matrix](https://matrix.to/#/#pixeldev:matrix.org)
11+
12+
## Social media
13+
14+
We maintain the following official social media accounts:
15+
16+
- [@pixelfed@pixelfed.social](https://pixelfed.social/pixelfed)
17+
- [@pixelfed@mastodon.social](https://mastodon.social/@pixelfed)
18+
- [x.com/Pixelfed](https://x.com/Pixelfed)

‎project/introduction.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Welcome to Pixelfed
2+
3+
### A fresh take on photo sharing. Get inspired with beautiful photos captured by people around the world.

‎running-pixelfed/configuration.md

+75-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,86 @@
11
---
22
title = "Pixelfed Configuration"
33
summary = "A list of configuration settings for Pixelfed"
4+
weight = 20
5+
[menu]
6+
[menu.docs]
7+
identifier = "admin/installation"
8+
parent = "admin"
49
---
510

611
# Configuration
712

8-
## Server Settings
13+
Pixelfed, a platform built on the Laravel framework, uses Laravel's efficient configuration system. Sensitive settings like database credentials are stored in a .env file, separate from the codebase for security. These values are then loaded into PHP configuration files (`config/*.php`) for easy access within the application.
14+
15+
::: warning
16+
Laravel also caches these configurations to improve performance, avoiding the need to read the .env file on every request. This is why you need to run `php artisan config:cache && php artisan cache:clear` after updating `.env` or `config/*.php` files
17+
:::
18+
19+
This setup allows Pixelfed to manage its settings effectively across different environments (development, staging, production) while keeping sensitive data secure. Changes to the .env file may require clearing Laravel's configuration cache to ensure the application uses the updated values.
20+
21+
---
22+
23+
[[toc]]
24+
25+
## config/app.php
926

1027
| .env key | Default | Description | Type |
1128
| ------------- | :-----------: | :----: | :----: |
12-
| APP_DOMAIN | NULL | The app domain | String |
1329
| APP_NAME | "Pixelfed" | The name of your server | String |
14-
| OPEN_REGISTRATION | true | If your server allows new account registrations | Boolean |
30+
| APP_ENV | "production" | The app environment, keep it set to "production" | String |
31+
| APP_URL | "https://localhost" | The app url of your server, used for generating urls. Should start with "https://" | String |
32+
| APP_LOCALE | "en" | The locale of your server | String |
33+
34+
## config/instance.php
35+
36+
| .env key | Default | Description | Type |
37+
| ------------- | :-----------: | :----: | :----: |
38+
| FORCE_HTTPS_URLS | true | Force https url generation | Boolean |
39+
| INSTANCE_DESCRIPTION | "Pixelfed - Photo sharing for everyone" | Your server description | String |
40+
| INSTANCE_CONTACT_FORM | false | Enable the contact form | Boolean |
41+
| INSTANCE_DISCOVER_PUBLIC | false | Enable public access to the Discover feature | Boolean |
42+
| INSTANCE_PUBLIC_HASHTAGS | false | Allow anonymous access to hashtag feeds | Boolean |
43+
| INSTANCE_CONTACT_EMAIL | NULL | The public contact email for your server | String |
44+
| STORIES_ENABLED | false | Enable the Stories feature | Boolean |
45+
| ENABLE_CONFIG_CACHE | true | Enable the config cache to allow you to manage settings via the admin dashboard | Boolean |
46+
| INSTANCE_PROFILE_EMBEDS | true | Enable the profile embed feature | Boolean |
47+
| INSTANCE_POST_EMBEDS | true | Enable the post embed feature | Boolean |
48+
| PF_HIDE_NSFW_ON_PUBLIC_FEEDS | false | Hide sensitive posts from public/network feeds | Boolean |
49+
| PF_LOCAL_AVATAR_TO_CLOUD | false | Store local avatars on S3 (Requires S3) | Boolean |
50+
| PF_ADMIN_INVITES_ENABLED | true | Enable the Admin Invites feature | Boolean |
51+
| PF_MAX_USER_BLOCKS | 50 | The max number of user blocks per account | Integer |
52+
| PF_MAX_USER_MUTES | 50 | The max number of user mutes per account | Integer |
53+
| PF_MAX_DOMAIN_BLOCKS | 50 | The max number of domain blocks per account | Integer |
54+
| INSTANCE_REPORTS_EMAIL_ENABLED | false | Send a report email to the admin account for new autospam/reports | Boolean |
55+
| INSTANCE_REPORTS_EMAIL_ADDRESSES | NULL | A comma separated list of email addresses to deliver admin reports to | String |
56+
| INSTANCE_REPORTS_EMAIL_AUTOSPAM | false | Enable autospam reports (require INSTANCE_REPORTS_EMAIL_ENABLED) | Boolean |
57+
| INSTANCE_LANDING_SHOW_DIRECTORY | true | Enable the profile directory on the landing page | Boolean |
58+
| INSTANCE_LANDING_SHOW_EXPLORE | true | Enable the popular post explore on the landing page | Boolean |
59+
| INSTANCE_CUR_REG | false | Enable Curated Registration | Boolean |
60+
| INSTANCE_SHOW_PEERS | false | Enable the api/v1/peers API endpoint | Boolean |
61+
62+
63+
## config/pixelfed.php
64+
65+
| .env key | Default | Description | Type |
66+
| ------------- | :-----------: | :----: | :----: |
67+
| APP_DOMAIN | NULL | The domain of your server, without `https://` | String |
68+
| OPEN_REGISTRATION | true | Enable open registration for new accounts | Boolean |
69+
| MAX_ACCOUNT_SIZE | 1000000 | The max allowed account size in KB | Integer |
70+
| MAX_PHOTO_SIZE | 15000 | The max photo/video size in KB | Integer |
71+
| MAX_AVATAR_SIZE | 2000 | The max user avatar size in KB | Integer |
72+
| MAX_CAPTION_LENGTH | 500 | The max post caption length | Integer |
73+
| MAX_BIO_LENGTH | 125 | The max user bio length | Integer |
74+
| MAX_NAME_LENGTH | 30 | The max user display name length | Integer |
75+
| MIN_PASSWORD_LENGTH | 8 | The min password length | Integer |
76+
| MAX_ALBUM_LENGTH | 4 | The max number of media per post album | Integer |
77+
| ENFORCE_EMAIL_VERIFICATION | true | Enforce email verification | Boolean |
78+
| IMAGE_QUALITY | 80 | Set the image optimization quality, between 1-100. Lower uses less space, higher more quality | Integer |
79+
| ACCOUNT_DELETION | true | Enable account deletion (may be a requirement in some jurisdictions) | Integer |
80+
| PF_ENABLE_CLOUD | false | Enable S3/Object Storage | Boolean |
81+
| PF_MAX_USERS | 1000 | Limit max user registrations | Integer |
82+
| PF_ENFORCE_MAX_USERS | 2000 | in KB | Integer |
83+
| PF_OPTIMIZE_IMAGES | true | Enable image optimization | Boolean |
84+
| PF_OPTIMIZE_VIDEOS | true | Enable video optimization | Boolean |
85+
| PF_MAX_COLLECTION_LENGTH | 100 | Max collection post limit | Integer |
86+
| OAUTH_ENABLED | true | Enable oAuth support, required for mobile/3rd party apps | Boolean |

0 commit comments

Comments
 (0)