From 2bf9d05e96a47710d59c242d54df25dd1d58b4d5 Mon Sep 17 00:00:00 2001 From: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Date: Fri, 15 Nov 2024 18:53:31 -0500 Subject: [PATCH] Move installation notes to bottom of self-host doc (#16034) --- docs/3.0/manage/self-host.mdx | 87 ++++++++++++++++++----------------- 1 file changed, 44 insertions(+), 43 deletions(-) diff --git a/docs/3.0/manage/self-host.mdx b/docs/3.0/manage/self-host.mdx index e6be83cb7dac..98252bcfd51e 100644 --- a/docs/3.0/manage/self-host.mdx +++ b/docs/3.0/manage/self-host.mdx @@ -14,49 +14,6 @@ Prefect Cloud and self-hosted Prefect server share a common set of capabilities. Prefect Cloud provides the additional features required by organizations such as RBAC, Audit logs, and SSO. See the [Prefect Cloud overview](/3.0/manage/cloud/) for more information. -## Prefect server installation notes - -Your self-hosted server must meet the following requirements and configuration settings. - -### SQLite - -SQLite is not packaged with the Prefect installation. But most systems already have SQLite installed, and it is typically bundled with Python. - -If you self-host a Prefect server instance with a SQLite database, certain Linux versions of SQLite can be problematic. -Compatible versions include Ubuntu 22.04 LTS and Ubuntu 20.04 LTS. - -To confirm SQLite is installed, run: - -```bash -sqlite3 --version -``` - -### Use a self-signed SSL certificate - -When using a self-signed SSL certificate, you need to configure your environment to trust the certificate. -Add the certificate to your system bundle and point your tools to use that bundle by configuring the -`SSL_CERT_FILE` environment variable. - -If the certificate is not part of your system bundle, set the -`PREFECT_API_TLS_INSECURE_SKIP_VERIFY` to `True` to disable certificate verification altogether. - - -Disabling certificate validation is insecure and only suggested as an option for testing. - - -### Proxies - -Prefect supports communicating with proxies through environment variables. -Whether you use a Prefect Cloud account or self-host a Prefect server instance, set `HTTPS_PROXY` and -`SSL_CERT_FILE` in your environment. -Then the underlying network libraries will route Prefect's requests appropriately. - -Alternatively, the Prefect library connects to the API through any proxies you have listed in the `HTTP_PROXY` or -`ALL_PROXY` environment variables. -You may also use the `NO_PROXY` environment variable to specify which hosts should not pass through the proxy. - -For more information about these environment variables, see the [cURL documentation](https://everything.curl.dev/usingcurl/proxies/env). - ## Self-host a Prefect server 1. Spin up a self-hosted Prefect server instance UI with the `prefect server start` CLI command in the terminal: @@ -246,3 +203,47 @@ prefect server database downgrade -y -r d20618ce678e To downgrade all migrations, use the `base` revision. See the [contributing docs](/contribute/dev-contribute) to learn how to create a database migration. + + +## Prefect server installation notes + +Your self-hosted server must meet the following requirements and configuration settings. + +### SQLite + +SQLite is not packaged with the Prefect installation. But most systems already have SQLite installed, and it is typically bundled with Python. + +If you self-host a Prefect server instance with a SQLite database, certain Linux versions of SQLite can be problematic. +Compatible versions include Ubuntu 22.04 LTS and Ubuntu 20.04 LTS. + +To confirm SQLite is installed, run: + +```bash +sqlite3 --version +``` + +### Use a self-signed SSL certificate + +When using a self-signed SSL certificate, you need to configure your environment to trust the certificate. +Add the certificate to your system bundle and point your tools to use that bundle by configuring the +`SSL_CERT_FILE` environment variable. + +If the certificate is not part of your system bundle, set the +`PREFECT_API_TLS_INSECURE_SKIP_VERIFY` to `True` to disable certificate verification altogether. + + +Disabling certificate validation is insecure and only suggested as an option for testing. + + +### Proxies + +Prefect supports communicating with proxies through environment variables. +Whether you use a Prefect Cloud account or self-host a Prefect server instance, set `HTTPS_PROXY` and +`SSL_CERT_FILE` in your environment. +Then the underlying network libraries will route Prefect's requests appropriately. + +Alternatively, the Prefect library connects to the API through any proxies you have listed in the `HTTP_PROXY` or +`ALL_PROXY` environment variables. +You may also use the `NO_PROXY` environment variable to specify which hosts should not pass through the proxy. + +For more information about these environment variables, see the [cURL documentation](https://everything.curl.dev/usingcurl/proxies/env).