Skip to content

Enable site configuration with ENV variables #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 16, 2025
Merged

Enable site configuration with ENV variables #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1b3fac
Read FASP configuration from environment variables
Floppy Sep 16, 2025
fdc38ff
Add new env vars to README
Floppy Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fediscoverer - Fediverse Search and Discovery Provider
# Fediscoverer - Fediverse Search and Discovery Provider

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

### Manual

Prerequisites:
Prerequisites:

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

## Usage

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

## License

Copyright (c) 2025 Mastodon gGmbH and contributors
Copyright (c) 2025 Mastodon gGmbH and contributors

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

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


10 changes: 5 additions & 5 deletions config/initializers/fasp_base.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
FaspBase.tap do |f|
# Replace with actual fasp name
f.fasp_name = Rails.application.name
f.fasp_name = ENV.fetch("FASP_NAME", Rails.application.name)

# Domain of the fasp, used to generate URLs outside of a requests context
f.domain = ENV["DOMAIN"] || ActionController::Base.default_url_options[:host] || "localhost:3000"
Expand All @@ -14,10 +14,10 @@
]

# Additional metadata
# f.privacy_policy_url = ENV["PRIVACY_POLICY_URL"]
# f.privacy_policy_language = ENV["PRIVACY_POLICY_LANGUAGE"]
# f.contact_email = ENV["CONTACT_EMAIL"]
# f.fediverse_account = ENV["FEDIVERSE_ACCOUNT"]
f.privacy_policy_url = ENV.fetch("PRIVACY_POLICY_URL", nil)
f.privacy_policy_language = ENV.fetch("PRIVACY_POLICY_LANGUAGE", nil)
f.contact_email = ENV.fetch("CONTACT_EMAIL", nil)
f.fediverse_account = ENV.fetch("FEDIVERSE_ACCOUNT", nil)
end

# If you plan to patch classes from the `fasp_base` engine
Expand Down
Loading