diff --git a/components/pages/home.tsx b/components/pages/home.tsx index 956cbd7..3ee799b 100644 --- a/components/pages/home.tsx +++ b/components/pages/home.tsx @@ -99,7 +99,7 @@ export default function Home() {

Deploy faster

- Don't waste time on configuration + From zero to deployed in minutes

Chose any app from our{' '} diff --git a/pages/docs/getting-started/installation.mdx b/pages/docs/getting-started/installation.mdx index 41d68ba..c878f45 100644 --- a/pages/docs/getting-started/installation.mdx +++ b/pages/docs/getting-started/installation.mdx @@ -2,6 +2,11 @@ import { Callout } from 'nextra-theme-docs' # Installation +## Introduction + +This guide will help you install Tipi on your server. Make sure your server is secured and you have followed basic security practices before installing Tipi. (e.g. firewall, ssh keys, root access, etc.) Here is a [good guide](https://www.tecmint.com/initial-ubuntu-server-setup-guide/) to follow. + + ## Hardware Requirements Our software uses containerization and has the same hardware requirements as Docker: @@ -25,6 +30,7 @@ Our software uses containerization and has the same hardware requirements as Doc ## OS Requirements + Ubuntu 18.04 LTS or higher is recommended. However other major Linux distribution are supported but may lead to installation issues. Please file an issue if you encounter one. diff --git a/pages/docs/guides/expose-your-apps.mdx b/pages/docs/guides/expose-your-apps.mdx index 714a9f6..87f36f9 100644 --- a/pages/docs/guides/expose-your-apps.mdx +++ b/pages/docs/guides/expose-your-apps.mdx @@ -1,5 +1,48 @@ +import Image from 'next/image' import { Callout } from 'nextra-theme-docs' - -This page is a stub. Help us expand it by contributing! +# Expose your apps + +Tipi allows you to expose your apps to the internet through a public domain that you own. Automatic HTTPS is provided by Let's Encrypt and Tipi will automatically renew your certificates. + + +Exposing your apps will make them accessible from the internet. Make sure you understand the security implications of doing so. Tipi is not responsible for any security breach that could happen on your server resulting from exposing your apps. + +## Prerequisites + +- You have a running Tipi instance on your server +- You have a running app on your server that you want to expose +- You own a domain name and have access to its DNS configuration +- You have access to your router configuration and know how to forward ports + +## Configure your router + +Tipi needs to be able to receive requests from the internet in order to generate the SSL certificates. To do so, you need to forward the port 80 and 443 of your router to the port 80 and 443 of your server. +This is a common operation and you can find a lot of tutorials on the internet on how to do it. + +## Configure your DNS + +Tipi needs to be able to verify that you own the domain name you want to expose your app on. To do so, you need to add an **A** record to your DNS configuration pointing to the public IP address of your server. + +For example, if you want to expose the `nextcloud` app on the `cloud.my-domain.io` domain, you need to add an **A** record for `cloud.my-domain.io` pointing to the public IP address of your server. + +## Expose your app from the dashboard + +Once your router and DNS are configured, you can expose your app from the dashboard. Go to the details page of the app you want to expose and click on the `Settings` button. +Enable the `Expose app` switch and enter the domain name you want to expose your app on. Click on the `Save` button to save your changes. + +
+ + +## Restart your app + +In order to take into account the changes you just made, you need to restart your app. Go to the details page of your app and click on the `Stop` button then on the `Start` button. + +## Profit! + +The rest is automatic. Tipi will automatically renew your certificates and expose your app on the domain name you entered. + + + + diff --git a/pages/docs/guides/linking-a-domain-to-your-dashboard.mdx b/pages/docs/guides/linking-a-domain-to-your-dashboard.mdx index c0db101..75afc8a 100644 --- a/pages/docs/guides/linking-a-domain-to-your-dashboard.mdx +++ b/pages/docs/guides/linking-a-domain-to-your-dashboard.mdx @@ -2,11 +2,10 @@ import { Callout } from 'nextra-theme-docs' - - This guide explains you how to link a domain to your dashboard. If you want to expose other apps, you need to configure them individually. You cannot use this guide to expose individual apps. + +For security reasons, it is highly discouraged to expose your dashboard to the internet. We recommend you to [expose only individual apps](/docs/guides/expose-your-apps). And follow this guide only if you have a particular use case (e.g. a demo instance of tipi) - If you want to link a domain to your dashboard, you can do so by providing the `domain` option in your dashboard settings or with the `settings.json` file. ```json diff --git a/public/images/expose-your-apps/expose-settings.png b/public/images/expose-your-apps/expose-settings.png new file mode 100644 index 0000000..51db2fb Binary files /dev/null and b/public/images/expose-your-apps/expose-settings.png differ