Skip to content

Commit

Permalink
docs: add expose your apps guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nicotsx committed Dec 11, 2023
1 parent d92b94d commit 62af44b
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 6 deletions.
2 changes: 1 addition & 1 deletion components/pages/home.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ export default function Home() {
<div className="lg:max-w-lg">
<p className="text-base font-semibold leading-7 text-blue-700">Deploy faster</p>
<h1 className="light:text-gray-900 mt-2 text-3xl font-bold tracking-tight sm:text-4xl">
Don&apos;t waste time on configuration
From zero to deployed in minutes
</h1>
<p className="light:text-gray-700 mt-6 text-xl leading-8">
Chose any app from our{' '}
Expand Down
6 changes: 6 additions & 0 deletions pages/docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

Expand Down
47 changes: 45 additions & 2 deletions pages/docs/guides/expose-your-apps.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,48 @@
import Image from 'next/image'
import { Callout } from 'nextra-theme-docs'

<Callout emoji="🚨">
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.

<Callout type="warning">
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.
</Callout>

## 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.

<br />
<Image src="/images/expose-your-apps/expose-settings.png" width={704} height={200} />

## 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.




5 changes: 2 additions & 3 deletions pages/docs/guides/linking-a-domain-to-your-dashboard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

import { Callout } from 'nextra-theme-docs'

<Callout emoji='⚠️' type='warning'>
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.
<Callout emoji="🚨">
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)
</Callout>


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
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 62af44b

@vercel
Copy link

@vercel vercel bot commented on 62af44b Dec 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.