📄️ Getting Started
This section only applies if you plan to self-host Unleash. If you are looking for our hosted solution you should head over to www.getunleash.io
📄️ Configuring Unleash
This is the guide on how to configure Unleash v4 self-hosted. If you are still using Unleash v3 you should checkout configuring Unleash v3
📄️ Database Setup
To run Unleash you need to have PostgreSQL database (PostgreSQL v10.x or newer).
📄️ Database Backup
When upgrading to a new major version of Unleash, we advise to do a full database backup to ease rollback in case of failures.
📄️ Email service
New since Unleash v4.0.0 is an email service allowing us to send reset password and welcome mails to new users. In order for this to work you'll need to tell unleash what SMTP service you'd like to send mails from.
📄️ Google Auth Hook
You can also find the complete source code for this guide in the unleash-examples project.
📄️ [Deprecated] Import & Export
The import and export API first appeared in Unleash 3.3.0.
📄️ Environment Import & Export
The environment import and export first appeared in Unleash 4.22.0.
📄️ Migration Guide
Generally, the intention is that unleash-server should always provide support for clients one major version lower than the current one. This should make it possible to upgrade unleash gradually.
📄️ Securing Unleash
If you are still using Unleash v3 you need to follow the securing-unleash-v3