Skip to content

Commit

Permalink
Reorganize self-hosting docs
Browse files Browse the repository at this point in the history
  • Loading branch information
frankie567 committed Feb 24, 2024
1 parent c67c6e0 commit 910f294
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/configure/tenants.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ Click on **Manage domain authentication** to see the list of DNS records you nee
![Tenant transactional emails domain authentication](/assets/images/admin-tenants-email-domain-authentication.png)

!!! warning "This feature is only supported with SendGrid"
If you self-host your Fief server, please note that only the [SendGrid provider](../self-hosting/deployment/setup-email-provider.md#sendgrid-provider) supports domain authentication from the admin dashboard. If you use SMTP or Postmark, you should manually authenticate your domain.
If you self-host your Fief server, please note that only the [SendGrid provider](../self-hosting/configuration/email-provider.md#sendgrid-provider) supports domain authentication from the admin dashboard. If you use SMTP or Postmark, you should manually authenticate your domain.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: Instructions to configure your Fief server on a PostgreSQL or MySQL database.
---

# Setup database
# Database

For production environments, your Fief server should store its data in a proper database server for better performance and reliability. Fief is compatible with **PostgreSQL** and **MySQL** databases.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
emails.
---

# Setup email provider
# Email provider

As you surely now, users management imply a lot of transactional emails, like welcome emails or reset password emails. To be able to send them, Fief needs an email provider.

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/self-hosting/deployment/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ We also defined a dedicated database container, PostgreSQL, and a broker for pas

The `.env` file will contain all the [environment variables](../environment-variables.md) for configuring Fief. You can have more details about the configuration of your database and email provider in the dedicated sections.

[Setup database](setup-database.md){ .md-button }
[Setup email provider](setup-email-provider.md){ .md-button }
[Configure database](../configuration/database.md){ .md-button }
[Configure email provider](../configuration/email-provider.md){ .md-button }
{: .buttons }

!!! warning "Backup the volumes"
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/deployment/render.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Render

[Render](https://render.com/) is a very popular Platform as a Service (PaaS). It allows to quickly host and serve your applications without worrying about server management. Actually, Fief Cloud is hosted on Render!
[Render](https://render.com/) is a very popular Platform as a Service (PaaS). It allows to quickly host and serve your applications without worrying about server management.

We provide an official blueprint creating all the services you need to run Fief.

Expand Down
8 changes: 4 additions & 4 deletions docs/self-hosting/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ For each variable, we'll try to provide a sensible example value to help you con
| `DATABASE_POOL_PRE_PING` | Whether to always issue a query before returning a database connection to make sure it's alive. [Read more](https://docs.sqlalchemy.org/en/14/core/pooling.html#disconnect-handling-pessimistic). | False | | |
| `DATABASE_URL` | Full database connection string, useful for some cloud providers. It'll take precedence over the single parameters above. | | | |

More details about how to setup a database in the dedicated section.
More details about how to configure a database in the dedicated section.

[Setup database](./deployment/setup-database.md){ .md-button }
[Configure database](./configuration/database.md){ .md-button }
{: .buttons }

### Redis
Expand All @@ -123,9 +123,9 @@ We use a Redis instance to manage background jobs (send emails, heavy computatio
| `DEFAULT_FROM_EMAIL` | Default transactional emails sender email address | [email protected] | | [email protected] |
| `DEFAULT_FROM_NAME` | Default transactional emails sender name | Fief | | Bretagne |

More details about how to setup an email provider in the dedicated section.
More details about how to configure an email provider in the dedicated section.

[Setup email provider](./deployment/setup-email-provider.md){ .md-button }
[Configure email provider](./configuration/email-provider.md){ .md-button }
{: .buttons }

### Webhooks
Expand Down
15 changes: 14 additions & 1 deletion docs/self-hosting/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
# TODO
# Self-hosting

Fief is a platform that you host for free on your own infrastructure.

In [Getting started](../getting-started/local-instance.md), we show you a way to easily start your instance locally. However, for production usage, we highly recommend you to perform a complete setup. We provide guides and blueprints to get you started on various **hosting technologies** and **cloud platforms**.


[Docker Compose](./deployment/docker-compose.md){ .md-button }
[Render](./deployment/render.md){ .md-button }
{: .buttons }

## Not sure ? 🤔

If you're not sure about the way to go, ask us on the [GitHub Discussions](https://github.com/orgs/fief-dev/discussions) forum. We're here to help!
2 changes: 1 addition & 1 deletion examples/deployment/docker-compose/.env
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ FIEF_DOMAIN=fief.mydomain.com
FIEF_MAIN_USER_EMAIL=[email protected]
FIEF_MAIN_USER_PASSWORD=XXX

# Read more: https://docs.fief.dev/self-hosting/deployment/setup-database/
# Read more: https://docs.fief.dev/self-hosting/configuration/database/
DATABASE_TYPE=POSTGRESQL
DATABASE_HOST=postgres
DATABASE_PORT=5432
Expand Down
9 changes: 5 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,13 @@ nav:
- Events: api/webhooks/events.md
- 'Self-hosting':
- self-hosting/index.md
- 'Production deployment':
- 'Deployment':
- self-hosting/deployment/docker-compose.md
- self-hosting/deployment/render.md
- self-hosting/deployment/setup-database.md
- self-hosting/deployment/setup-email-provider.md
- self-hosting/deployment/ssl.md
- 'Configuration':
- self-hosting/configuration/database.md
- self-hosting/configuration/email-provider.md
- self-hosting/configuration/ssl.md
- self-hosting/environment-variables.md
- Telemetry: telemetry.md
- migration.md

0 comments on commit 910f294

Please sign in to comment.