Skip to content

Commit cddf98a

Browse files
Floppyoneiros
authored andcommitted
Add new env vars to README
1 parent ee9374e commit cddf98a

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Fediscoverer - Fediverse Search and Discovery Provider
1+
# Fediscoverer - Fediverse Search and Discovery Provider
22

33
fediscoverer is a Fediverse Discovery Provider allowing fediverse
44
servers to share publicly discoverable accounts and content to improve
@@ -12,7 +12,7 @@ This project is in very early stages but we appreciate feedback.
1212

1313
### Manual
1414

15-
Prerequisites:
15+
Prerequisites:
1616

1717
* Ruby (we recommend using a version manager such as mise, asdf or
1818
rbenv, which will pick up the correct version from `.ruby-version`)
@@ -155,6 +155,11 @@ fediscoverer can be configured using environment variables. Here is a
155155
| `PROMETHEUS_EXPORTER_ENABLED` | No | false | Enable metrics gathering |
156156
| `PROMETHEUS_EXPORTER_HOST` | No | `localhost` | Host where the `prometheus_exporter` service is running |
157157
| `PROMETHEUS_EXPORTER_PORT` | No | `9394` | Port that the `prometheus_exporter` service is listening on |
158+
| `FASP_NAME` | No | `fediscoverer` | The name of your instance, returned in provider info |
159+
| `PRIVACY_POLICY_URL` | No | | A link to your privacy policy |
160+
| `PRIVACY_POLICY_LANGUAGE` | No | | The two-letter code for the language your policy is written in |
161+
| `CONTACT_EMAIL` | No | | A contact email for your instance |
162+
| `FEDIVERSE_ACCOUNT` | No | | A contact fediverse account for your instance |
158163

159164
## Usage
160165

@@ -249,7 +254,7 @@ See https://github.com/mastodon/.github/blob/main/CONTRIBUTING.md
249254

250255
## License
251256

252-
Copyright (c) 2025 Mastodon gGmbH and contributors
257+
Copyright (c) 2025 Mastodon gGmbH and contributors
253258

254259
Licensed under GNU Affero General Public License as stated in the [LICENSE](LICENSE):
255260

@@ -269,5 +274,3 @@ details.
269274
You should have received a copy of the GNU Affero General Public License along
270275
with this program. If not, see https://www.gnu.org/licenses/
271276
```
272-
273-

0 commit comments

Comments
 (0)