docs/big-cleanup (#35)

* I will not even bother to describe * docs: change use RUNTIPI_APP_DATA_PATH in running locally section * docs: fix typo in installation * docs: remove <br> in callout * docs: make _meta.json titles match with guide titles * docs: use repository instead of repo * docs: don't use should because Nicolas doesn't like it * docs: add an extra step in editing the traefik config * docs: add missing bash decleration to using the cli * docs: fix typo * docs: small adjustments --------- Co-authored-by: Nicolas Meienberger <[email protected]>
runtipi · May 21, 2024 · 2700034 · 2700034
1 parent a6de002
commit 2700034
Show file tree

Hide file tree

Showing 41 changed files with 4,456 additions and 3,444 deletions.
diff --git a/.github/screenshot.png b/.github/screenshot.png
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+.next
+node_modules
+pnpm-lock.yaml
+package-lock.json
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Nextra Docs Template 
+# Nextra Docs Template
 
 This is a template for creating documentation with [Nextra](https://nextra.site).
 

diff --git a/components/AppsList.tsx b/components/AppsList.tsx
@@ -11,7 +11,7 @@ type App = {
 
 export const getStaticProps = async () => {
   const apps: Record<string, App> = {};
-  // fetch apps from app store repo
+  // fetch apps from app store repository
   const res = await fetch('https://api.github.com/repos/runtipi/runtipi-appstore/contents/apps');
 
   const data = await res.json();

diff --git a/components/pages/home.tsx b/components/pages/home.tsx
@@ -33,7 +33,7 @@ export default function Home() {
               management made easy.
             </h1>
             <p className="mt-6 max-w-2xl text-xl font-medium leading-tight text-gray-400">
-              Free and open-source, Runtipi lets you install all your favorite self-hosted apps
+              Free and open-source, runtipi lets you install all your favorite self-hosted apps
               without the hassle of configuring and managing each service. One-click installs and
               updates for more than 200 popular apps.
             </p>

diff --git a/package.json b/package.json
@@ -32,7 +32,7 @@
     "react-dom": "^18.2.0",
     "react-hot-toast": "^2.4.1",
     "react-image-comparison-slider": "^1.8.4",
-    "sass": "^1.70.0",
+    "sass": "^1.71.1",
     "sharp": "^0.32.6"
   },
   "devDependencies": {

diff --git a/pages/about.mdx b/pages/about.mdx
@@ -2,21 +2,21 @@ import { AppScreenshot } from '@/components/AppScreenshot';
 
 # About
 
-Tipi is an open source personal homeserver orchestrator that enables you to manage and run multiple services on a single server.
+Runtipi is an open source personal homeserver orchestrator that enables you to manage and run multiple services on a single server.
 It is based on Docker and comes with a user-friendly web interface that simplifies service management.
-With Tipi, you no longer need to worry about manual configuration or networking.
-Install Tipi on your server and use the web interface to add and manage services.
+With runtipi, you no longer need to worry about manual configuration or networking.
+Install runtipi on your server and use the web interface to add and manage services.
 
-At its core, Tipi is designed to be easy to use and accessible for everyone.
-Whether you are an experienced developer or a beginner, Tipi allows you to focus on the services you want to run without the need for extensive technical knowledge.
+At its core, runtipi is designed to be easy to use and accessible for everyone.
+Whether you are an experienced developer or a beginner, runtipi allows you to focus on the services you want to run without the need for extensive technical knowledge.
 The project's philosophy is to democratize the ability to self-host services by providing a simple, yet powerful tool that enables everyone to host their own services.
 
-Tipi comes with an extensive library of services in the [App Store](/docs/apps-available).
+Runtipi comes with an extensive library of services in the [App Store](/docs/apps-available).
 If you cannot find what you need, you can request new services, and the community can work together to develop them.
 
-Tipi is still in its early stages of development, and issues may occur. Nevertheless, the community is continuously working to improve the project, and everyone is welcome to contribute.
+Runtipi is in continuous development, so issues may occur. Nevertheless, the community is continuously working to improve the project, and everyone is welcome to contribute.
 
-To get started with Tipi, follow the installation instructions, and enjoy hosting your own services effortlessly.
+To get started with runtipi, follow the installation instructions, and enjoy hosting your own services effortlessly.
 
 <br />
 <AppScreenshot />
diff --git a/pages/docs/apps-available.mdx b/pages/docs/apps-available.mdx
@@ -22,7 +22,7 @@ export const AppsCount = () => {
 
 # Apps available
 
-Tipi has a wide range of selfhosted apps you can install on your server. You can find them all in the [app store repo](https://github.com/runtipi/runtipi-appstore) and make requests for new apps there.
+Runtipi has a wide range of selfhosted apps you can install on your server. You can find them all in the [app store repository](https://github.com/runtipi/runtipi-appstore) and make requests for new apps there.
 
 <AppsCount />
 <Apps />
diff --git a/pages/docs/contributing/adding-a-new-app.mdx b/pages/docs/contributing/adding-a-new-app.mdx
diff --git a/pages/docs/contributing/running-locally.mdx b/pages/docs/contributing/running-locally.mdx
@@ -1,45 +1,50 @@
 # Running locally
 
-In this guide we will show you how to run Tipi locally on your machine. This is useful if you want to contribute to the project or if you want to test new apps you added to the appstore.
+In this guide we will show you how to run runtipi locally on your machine. This is useful if you want to contribute to the project or if you want to test new apps you added to the appstore.
 
 ## Prerequisites
+
 - Docker desktop up to date and running. Instructions: [Install Docker Engine](https://docs.docker.com/engine/install/)
 - Docker-compose
 - Node version 16+
 
 ## Prepare
-Once you have forked the repo and cloned it on your local machine you can start to prepare the environment.
+
+Once you have forked the repository and cloned it on your local machine you can start to prepare the environment.
 
 ## Install dependencies
-Tipi uses `pnpm` as a package manager and monorepo orchestrator. Install it with
+
+runtipi uses `pnpm` as a package manager and monorepo orchestrator. Install it with
 `npm i -g pnpm`
 
 Install the project dependencies
 `pnpm i`
 
-## Edit the envs
+## Edit the environment variables
 
 You need to copy `.env.exemple` to `.env` and edit there following env
 
 - ROOT_FOLDER_HOST change to put your root folder of runtipi
-- STORAGE_PATH change to put your storage folder of runtipi 
+- RUNTIPI_APP_DATA_PATH change to put your app data folder of runtipi
+
+## Run runtipi
 
-## Run Tipi
 1. Start the app with `npm run start:dev` from the root folder
-2. Visit `localhost:3000` in your browser
+2. Visit `localhost` in your browser
+
+## Using your own appstore repository
 
-## Using your own appstore repo
-You can change the repository Tipi is using to retrieve the appstore in order to test new apps you added.
+You can change the repository runtipi is using to retrieve the appstore in order to test new apps you added.
 
-Create a `settings.json` file in the `state` folder (`runtipi/state/settings.json`) containing the URL of your repo and restart Tipi.
+Create a `settings.json` file in the `state` folder (`runtipi/state/settings.json`) containing the URL of your repository and restart runtipi.
 
 ```json
 {
   "appsRepoUrl": "https://github.com/runtipi/runtipi-appstore.git"
 }
 ```
 
-If you need to be on a different branch than the main one in your repo, write your repo URL using the following notation :
+If you need to be on a different branch than the main one in your repository, write your repository URL using the following notation :
 
 ```json
 {

diff --git a/pages/docs/contributing/running-the-cli-locally.mdx b/pages/docs/contributing/running-the-cli-locally.mdx
@@ -1,12 +1,32 @@
 # Running the CLI locally
 
-While the CLI is not meant to run during development, when developing new features for the CLI, it is useful to run it locally to test your changes.
+## Overview
 
-You can do so by navigating to the `packages/cli` folder and executing the following command:
+During development it is useful to be able to run the cli locally to test any changes you make.
+
+## Requirements
+
+- Rust needs to be installed
+- Git needs to be installed
+
+## Running the cli
+
+You firstly need to clone the cli repository. This can be done with this command:
+
+```bash
+git clone https://github.com/runtipi/cli
+```
+
+Then you can run the cli with this command:
+
+```bash
+cargo run
+```
+
+If you need to build the cli you can do so with this command:
 
 ```bash
-NODE_ENV=development npx tsx ./src/index.ts <command>
+cargo build
 ```
 
-This will run the CLI using the TypeScript compiler and execute the `index.ts` file with the given command.
-This command is the equivalent of running `./runtipi-cli <command>` on a production instance.
+If everything succeeds the cli should be located in `target/debug/runtipi-cli`.
diff --git a/pages/docs/getting-started/custom-settings.mdx b/pages/docs/getting-started/custom-settings.mdx
@@ -29,8 +29,8 @@ You can change the default settings by creating a `settings.json` file. The file
 | `localDomain`          | The domain name to use for local services                                   | `string`   | `tipi.lan`                                    |
 | `appsRepoUrl`          | The URL to the apps repository                                              | `string`   | `https://github.com/runtipi/runtipi-appstore` |
 | `postgresPort`         | The port to use for the postgres database                                   | `interger` | `5432`                                        |
-| `demoMode`             | Start tipi in demo mode                                                     | `boolean`  | `false`                                       |
+| `demoMode`             | Start runtipi in demo mode                                                  | `boolean`  | `false`                                       |
 | `guestDashboard`       | Allow guest access to the dashboard                                         | `boolean`  | `false`                                       |
 | `allowErrorMonitoring` | Whether the app will send anonymous crash reports to the runtipi developers | `boolean`  | `true`                                        |
 | `allowAutoTheme`       | Enables thematically changing the dashboard based on the time of the year   | `boolean`  | `true`                                        |
-| `persistTraefikConfig` | Do not replace the traefik config on every restart of tipi.                 | `boolean`  | `true`                                        |
+| `persistTraefikConfig` | Do not replace the traefik config on every restart of runtipi.              | `boolean`  | `true`                                        |
diff --git a/pages/docs/getting-started/installation.mdx b/pages/docs/getting-started/installation.mdx
@@ -4,7 +4,7 @@ import { Callout } from 'nextra-theme-docs';
 
 ## 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.
+This guide will help you install runtipi 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
 
@@ -28,7 +28,7 @@ Our software uses containerization and has the same hardware requirements as Doc
 - arm64
 
 <Callout>
-  Not all apps are supported in the arm64 architecture, tipi will auto hide apps that are not
+  Not all apps are supported in the arm64 architecture, runtipi will auto hide apps that are not
   supported by your architecture.
 </Callout>
 
@@ -37,12 +37,11 @@ Our software uses containerization and has the same hardware requirements as Doc
 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.
 
-If Docker is already installed on your machine, Tipi will use it to run the dashboard. Otherwise, it will install Docker for you.
+If Docker is already installed on your machine, runtipi will use it to run the dashboard. Otherwise, it will install Docker for you.
 
 <Callout type="warning">
-  If you already have docker installed make sure to have the docker compose plugin installed.
-  <br />
-  Run `docker compose version` to check if it is installed. Instructions to install it can be found
+  If you already have docker installed make sure to have the docker compose plugin installed. Run
+  `docker compose version` to check if it is installed. Instructions to install it can be found
   [here](https://docs.docker.com/compose/install/linux/).
 </Callout>
 
@@ -65,9 +64,9 @@ If you still want to run on a VPS, here are a few steps to consider in order to
 - Install a VPN like tailscale to create a secure and trusted private network to access your apps.
 - If an app needs to be accessed from the public, always use a tunnel and set it up specifically for this app
 
-## Download and install Tipi
+## Download and install runtipi
 
-Download the latest version of Tipi:
+Download the latest version of runtipi:
 
 ```bash
 curl -L https://setup.runtipi.io | bash
@@ -81,7 +80,7 @@ curl -L https://raw.githubusercontent.com/runtipi/runtipi/master/scripts/install
 
 ## Update
 
-This command updates tipi to the latest version available.
+This command updates runtipi to the latest version available.
 
 You can update to the latest version with this command:
 
@@ -97,6 +96,6 @@ sudo ./runtipi-cli update v2.0.7
 ```
 
 <Callout type="warning">
-  You can downgrade Tipi to a previous version by running the update command with the version you
+  You can downgrade runtipi to a previous version by running the update command with the version you
   want to downgrade to. However, this is highly discouraged as it may lead to breaking your install.
 </Callout>
diff --git a/pages/docs/getting-started/using-the-cli.mdx b/pages/docs/getting-started/using-the-cli.mdx
@@ -2,7 +2,7 @@ import { Callout } from 'nextra-theme-docs';
 
 # Using the CLI
 
-The runtipi-cli is a command line tool that allows you to start, stop, restart, update, and manage tipi from the command line.
+The runtipi-cli is a command line tool that allows you to start, stop, restart, update, and manage runtipi from the command line.
 
 Usage:
 
@@ -12,37 +12,37 @@ Usage:
 
 ## Start Command
 
-To start tipi run the following command:
+To start runtipi run the following command:
 
 ```bash
 sudo ./runtipi-cli start
 ```
 
 <Callout type="info">
-  Tipi is run as root in the examples because during the start process it needs to check and
+  Runtipi is run as root in the examples because during the start process it needs to check and
   eventually change the permissions of some files in the `runtipi` folder. You can run the command
   without sudo if needed but you may encounter permission issues.
 </Callout>
 
 ## Stop Command
 
-To stop tipi run the following command:
+To stop runtipi run the following command:
 
 ```bash
 sudo ./runtipi-cli stop
 ```
 
 ## Restart Command
 
-To restart tipi from the command line run this command:
+To restart runtipi from the command line run this command:
 
 ```bash
 sudo ./runtipi-cli restart
 ```
 
 ## Update
 
-This command updates tipi to the latest version available.
+This command updates runtipi to the latest version available.
 
 You can update to the latest version with this command:
 
@@ -57,7 +57,7 @@ sudo ./runtipi-cli update v2.0.7
 ```
 
 <Callout type="warning">
-  You can downgrade Tipi to a previous version by running the update command with the version you
+  You can downgrade runtipi to a previous version by running the update command with the version you
   want to downgrade to. However, this is highly discouraged as it may lead to breaking your install.
   Make sure you know what you are doing.
 </Callout>
@@ -66,7 +66,7 @@ sudo ./runtipi-cli update v2.0.7
 
 This command is used to reset a forgotten admin password.
 
-To reset your password run the following command and visit the tipi rest page at `http://<your-ip>/reset-password`
+To reset your password run the following command and visit the runtipi rest page at `http://<your-ip>/reset-password`
 it should prompt you to enter your new password.
 
 ```bash
@@ -77,7 +77,7 @@ it should prompt you to enter your new password.
 
 This command can be used to start and stop apps from the cli.
 
-```
+```bash
 ./runtipi-cli app [command] <app>
 ```
 
@@ -95,7 +95,7 @@ This command can be used to start and stop apps from the cli.
 
 ## Debug command
 
-This command is used to display useful information about the tipi installation. It can be used to troubleshoot issues.
+This command is used to display useful information about the runtipi installation. It can be used to troubleshoot issues.
 
 To use this command just run this:
 

diff --git a/pages/docs/guides/_meta.json b/pages/docs/guides/_meta.json
@@ -3,13 +3,16 @@
     "title": "Customize app config"
   },
   "customize-compose-and-traefik": {
-    "title": "Customize tipi compose and traefik config"
+    "title": "Customize runtipi compose and traefik config"
   },
   "expose-your-apps": {
     "title": "Expose your apps"
   },
   "expose-apps-with-cloudflare-tunnels": {
-    "title": "Expose apps with cloudflare tunnels"
+    "title": "Expose your apps using Cloudflare tunnels"
+  },
+  "dns-challenge-cloudflare": {
+    "title": "Setup a DNS challenge with Cloudflare"
   },
   "linking-a-domain-to-your-dashboard": {
     "title": "Linking a domain to your dashboard"
@@ -24,6 +27,6 @@
     "title": "Backup and restore"
   },
   "auto-update-with-cron": {
-    "title": "Auto update with cron"
+    "title": "Auto update your instance with cron"
   }
 }