diff --git a/docs/getting-started.md b/docs/getting-started.md index 2d237c00ed..f31ae85ef2 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -37,7 +37,10 @@ Available unleash options includes: - **databaseUrl** - the postgress database url to connect to. Should include username/password. - **port** - Which port should the unleash-server bind to? -- **enableLegacyRoutes** (boolean) - allows you to turn on/off support for legacy routes to support older clients. +- **enableLegacyRoutes** (boolean) - allows you to turn on/off support for legacy routes to support older clients. Enabled by default. +- **serverMetrics** (boolean) - Use this option to turn of prometheus metrics. +- **preHook** (function) - This is a hook if you need to provide any middlewares to express before `unleash` adds any. Express app instance is injected as first arguement. +- **preRouterHook** (function) - Use this to register custom express middlewares before the `unleash` specific routers are added. This is typically how you would register custom middlewares to handle authentication. ## How do I configure the log output? diff --git a/docs/migration-guide.md b/docs/migration-guide.md index c89761cf5c..5f3c8b4dc7 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -1,6 +1,13 @@ # Migrations guide +Generally the intention is that `unleash-server` should always provide support for clients one lower major version. This should make it easier to upgrade `unleash` gradually. -## Upgrading from v1.0 to 2.0 + +## Upgrading from v2.x to v3.x +First your should upgrade the `unleash-server` to v3 (which still supports v2 clients). After this is done you should upgrade all your clients to v3. + +After upgrading all your clients you should consider turning off legacy routes, used by v2 clients. Read more about this option in in the [gettings started guide](https://github.com/Unleash/unleash/blob/master/docs/getting-started.md#2-or-programmatically) + +## Upgrading from v1.0 to v2.0 ### Caveat 1: Not used db-migrate to migrate the unleash database? In FINN we used, for internal reasons, liquebase to migrate our database.