From f291f9e75818c20fc3cb07fb45c37010f12ac1a9 Mon Sep 17 00:00:00 2001
From: Ciaran Ainsworth <ciaranainsworth@outlook.com>
Date: Tue, 25 Jan 2022 11:04:12 +0100
Subject: [PATCH] Add quick install doc

---
 .../installation_docs/debian/index.md         | 15 +++++++---
 .../installation_docs/docker/index.md         |  6 ++++
 .../installation_docs/index.md                | 12 +++++++-
 .../installation_docs/quick_install/index.md  | 29 +++++++++++++++++++
 4 files changed, 57 insertions(+), 5 deletions(-)
 create mode 100644 docs/administrator_documentation/installation_docs/quick_install/index.md

diff --git a/docs/administrator_documentation/installation_docs/debian/index.md b/docs/administrator_documentation/installation_docs/debian/index.md
index a11f983f7..924a01391 100644
--- a/docs/administrator_documentation/installation_docs/debian/index.md
+++ b/docs/administrator_documentation/installation_docs/debian/index.md
@@ -9,11 +9,18 @@ We support [Debian](https://debian.org) and Debian-based Linux distributions. Fo
 
 ## Before you begin
 
-Set a `FUNKWHALE_VERSION` variable to the version you want to install. You will use this version for all commands in this guide.
+- Set a `FUNKWHALE_VERSION` variable to the version you want to install. You will use this version for all commands in this guide.
 
-```{parsed-literal}
-export FUNKWHALE_VERSION={sub-ref}`version`
-```
+   ```{parsed-literal}
+   export FUNKWHALE_VERSION={sub-ref}`version`
+   ```
+
+- Install `curl`.
+
+   ```{code} bash
+   sudo apt update # update apt cache
+   sudo apt install curl
+   ```
 
 ## 1. Install Funkwhale dependencies
 
diff --git a/docs/administrator_documentation/installation_docs/docker/index.md b/docs/administrator_documentation/installation_docs/docker/index.md
index ebe6efe21..591282c60 100644
--- a/docs/administrator_documentation/installation_docs/docker/index.md
+++ b/docs/administrator_documentation/installation_docs/docker/index.md
@@ -19,6 +19,12 @@ This guide assumes you are using a [Debian](https://debian.org)-based system.
    ```
 
 - Install [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/).
+- Install `curl`.
+
+   ```{code} bash
+   sudo apt update # update apt cache
+   sudo apt install curl
+   ```
 
 ## 1. Download the project files
 
diff --git a/docs/administrator_documentation/installation_docs/index.md b/docs/administrator_documentation/installation_docs/index.md
index 3ce9ea730..8100984cd 100644
--- a/docs/administrator_documentation/installation_docs/index.md
+++ b/docs/administrator_documentation/installation_docs/index.md
@@ -1,12 +1,22 @@
 # Install Funkwhale on your server
 
+Choose your installation method and follow the guides to set up your pod.
+
+## Requirements
+
+Funkwhale requires the following:
+
+- __A dedicated domain or subdomain__  – you can't run Funkwhale in a subdirectory of a domain. You need to run it on a domain or a subdomain. For example: `https://mypod.io` or `https://funkwhale.mysite.io`.
+- __Access to ports `80` and `443`__ – Funkwhale uses these ports for federation.
+
 ```{toctree}
 ---
 caption: Choose your installation method
 maxdepth: 1
 ---
 
-debian/index
+quick_install/index
 docker/index
+debian/index
 
 ```
diff --git a/docs/administrator_documentation/installation_docs/quick_install/index.md b/docs/administrator_documentation/installation_docs/quick_install/index.md
new file mode 100644
index 000000000..ebf692a6a
--- /dev/null
+++ b/docs/administrator_documentation/installation_docs/quick_install/index.md
@@ -0,0 +1,29 @@
+# Install Funkwhale with the quick install script
+
+The quick install script is the easiest way to install Funkwhale. Run this script on a [Debian](https://debian.org)-based server to get your pod set up.
+
+## Before you begin
+
+- You need `sudo` access to run the quick install script.
+- The quick install script installs Nginx, PostgreSQL, and Redis by default. You can customize this behavior by selecting the options in the script.
+
+## 1. Install dependencies
+
+To download the quick install script, install `curl`:
+
+```{code} bash
+sudo apt update # update the apt cache
+sudo apt install curl
+```
+
+## 2. Install Funkwhale
+
+Now that you have `curl` installed, download and run the quick install script:
+
+```{code} bash
+sudo sh -c "$(curl -sSL https://get.funkwhale.audio/)"
+```
+
+The script will prompt you to enter information about your instance. Follow the onscreen prompts until the script completes.
+
+That's it! You've finished installing Funkwhale. You should now be able to visit your pod in your web browser.