diff --git a/docs/self-hosting/configuration.md b/docs/self-hosting/configuration.md index 780a69a..6f91d3a 100644 --- a/docs/self-hosting/configuration.md +++ b/docs/self-hosting/configuration.md @@ -86,6 +86,18 @@ DB_USERNAME="***" DB_PASSWORD="***" ``` +## PDF rendering + +If you want to use solidtime features that create PDFs, like exporting a report as PDF, you need to configure a PDF rendering server. +solidtime uses [Gotenberg](https://gotenberg.dev/) to render PDFs. +The application needs to be able to send requests to the Gotenberg server. +The self-hosting guide already includes a Gotenberg container. +The environment variable `GOTENBERG_URL` is used to configure the URL of the Gotenberg server. + +```bash +GOTENBERG_URL=http://gotenberg:3000 +``` + ## Email Configure the email settings for sending emails. Solidtime supports every (transactional) mail service that offers an SMTP integration. diff --git a/docs/self-hosting/guides/docker.md b/docs/self-hosting/guides/docker.md index 4221163..9ddf4aa 100644 --- a/docs/self-hosting/guides/docker.md +++ b/docs/self-hosting/guides/docker.md @@ -113,11 +113,41 @@ To do this you can set the environment variable `AUTO_DB_MIGRATE` to `true` in t You can now access the application in your browser. The URL depends on your setup. -### 7. Testing the setup (optional) +### 7. Create a user + +Depending on your configuration of the `APP_ENABLE_REGISTRATION` environment variable, you can either create a user via the registration form or you need to create a user via the CLI. +Per default the registration is disabled. + +You can create a user via the CLI with the following command: + +```bash +docker compose exec scheduler php artisan admin:user:create "Firstname Lastname" "firstname.lastname@some-email-provider.test" --verify-email +``` + +More information about the CLI commands can be found in the [CLI commands documentation](../cli-commands). + +If you want this first user to be a super admin, you can add the email address to the `SUPER_ADMINS` environment variable in the `laravel.env` file. + +```env +SUPER_ADMINS="firstname.lastname@some-email-provider.test" +``` + +The command output a random password for the user. +Afterwards you need to restart the containers: + +```bash +docker compose down && docker compose up -d +``` + +Then you should be able log in with the user you created. +If the user is a super admin, you can access the super admin panel via `/admin`. +More information about the super admin panel can be found in the [super admin panel documentation](../super-admin-panel). + +### 8. Testing the setup (optional) You can find information about how to test the setup in the [testing documentation](../testing). -### 8. Activate Desktop client access (optional) +### 9. Activate Desktop client access (optional) The solidtime Desktop client authenticates with the API with OAuth. The Desktop client needs a client. You can create a client by running the following command: