2025-05-25 14:48:53 +00:00
import { Config , PartialDeep } from './lib/types.ts' ;
/** Check the Config type for all the possible options and instructions. */
const config : PartialDeep < Config > = {
auth : {
2025-06-05 17:10:40 +00:00
baseUrl : 'http://localhost:8000' , // The base URL of the application you use to access the app, i.e. "http://localhost:8000" or "https://cloud.example.com" (SSO redirect, if enabled, will be this + /oidc/callback, so "https://cloud.example.com/oidc/callback")
2025-05-25 14:48:53 +00:00
allowSignups : false , // If true, anyone can sign up for an account. Note that it's always possible to sign up for the first user, and they will be an admin
Migrate email provider (from Brevo to generic SMTP) (#67)
This means we now need to have the text and HTML content set in the code, which is arguably better.
In order to avoid allowing legacy Brevo API Key support, this will also introduce breaking changes and will be released as v2.0.0.
I took the opportunity to remove a few deprecated things (like legacy ENV-based config), upgrade PostgreSQL, and pin a specific version in `docker-compose.yml`, since I don't plan to do breaking releases anytime soon, and upgrading PostgreSQL should be fine from now on if the version is pinned.
If you were using Brevo with an API Key, they support SMTP as well, just update your config.
If you were using ENV-based config, check `bewcloud.config.sample.ts`to create your `bewcloud.config.ts`.
If you need help upgrading you PostgreSQL container, I've written a simple guide [step-by-step guide](https://news.onbrn.com/step-by-step-guide-upgrading-postgresql-docker-containers/).
2025-06-10 09:28:13 +00:00
enableEmailVerification : false , // If true, email verification will be required for signups (using SMTP settings below)
2025-05-25 14:48:53 +00:00
enableForeverSignup : true , // If true, all signups become active for 100 years
2025-06-11 14:53:39 +00:00
enableMultiFactor : false , // If true, users can enable multi-factor authentication (TOTP, Passkeys, or Email if the SMTP settings below are set)
2025-05-25 14:48:53 +00:00
// allowedCookieDomains: ['example.com', 'example.net'], // Can be set to allow more than the baseUrl's domain for session cookies
// skipCookieDomainSecurity: true, // If true, the cookie domain will not be strictly set and checked against. This skipping slightly reduces security, but is usually necessary for reverse proxies like Cloudflare Tunnel
2025-07-26 08:13:59 +00:00
// enableSingleSignOn: false, // If true, single sign-on will be enabled
// singleSignOnUrl: '', // The Discovery URL (AKA Issuer) of the identity/single sign-on provider
// singleSignOnEmailAttribute: 'email', // The attribute to prefer as email of the identity/single sign-on provider
// singleSignOnScopes: ['openid', 'email'], // The scopes to request from the identity/single sign-on provider
2025-05-25 14:48:53 +00:00
} ,
// files: {
// rootPath: 'data-files',
2025-06-20 11:04:16 +00:00
// allowPublicSharing: false, // If true, public file sharing will be allowed (still requires a user to enable sharing for a given file or directory)
2025-05-25 14:48:53 +00:00
// },
// core: {
Basic CardDav UI (Contacts)
This implements a basic CardDav UI, titled "Contacts". It allows creating new contacts with a first name + last name, and editing their first and last names, main email, main phone, and notes.
You can also import and export VCF (VCARD) files.
It also allows editing the VCARD directly, for power users.
Additionally, you can choose, create, or delete address books, and if there's no address book created yet in your CardDav server (first-time setup), it'll automatically create one, titled "Contacts".
Finally, there are some dependency updates and a fix for the config not allowing disabling the `cardDav` or the `calDav` server.
Related to #56
2025-08-10 06:48:16 +00:00
// enabledApps: ['news', 'notes', 'photos', 'expenses', 'contacts], // dashboard and files cannot be disabled
2025-05-25 14:48:53 +00:00
// },
// visuals: {
// title: 'My own cloud',
// description: 'This is my own cloud!',
// helpEmail: '',
// },
Migrate email provider (from Brevo to generic SMTP) (#67)
This means we now need to have the text and HTML content set in the code, which is arguably better.
In order to avoid allowing legacy Brevo API Key support, this will also introduce breaking changes and will be released as v2.0.0.
I took the opportunity to remove a few deprecated things (like legacy ENV-based config), upgrade PostgreSQL, and pin a specific version in `docker-compose.yml`, since I don't plan to do breaking releases anytime soon, and upgrading PostgreSQL should be fine from now on if the version is pinned.
If you were using Brevo with an API Key, they support SMTP as well, just update your config.
If you were using ENV-based config, check `bewcloud.config.sample.ts`to create your `bewcloud.config.ts`.
If you need help upgrading you PostgreSQL container, I've written a simple guide [step-by-step guide](https://news.onbrn.com/step-by-step-guide-upgrading-postgresql-docker-containers/).
2025-06-10 09:28:13 +00:00
// email: {
// from: 'help@bewcloud.com',
// host: 'localhost',
// port: 465,
// },
2025-07-20 09:35:32 +00:00
// contacts: {
// enableCardDavServer: true,
// cardDavUrl: 'http://127.0.0.1:5232',
// },
// calendar: {
// enableCalDavServer: true,
// calDavUrl: 'http://127.0.0.1:5232',
// },
2025-05-25 14:48:53 +00:00
} ;
export default config ;