Add quick install doc
This commit is contained in:
parent
b05a5f104c
commit
f291f9e758
|
@ -9,12 +9,19 @@ We support [Debian](https://debian.org) and Debian-based Linux distributions. Fo
|
||||||
|
|
||||||
## Before you begin
|
## 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}
|
```{parsed-literal}
|
||||||
export FUNKWHALE_VERSION={sub-ref}`version`
|
export FUNKWHALE_VERSION={sub-ref}`version`
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- Install `curl`.
|
||||||
|
|
||||||
|
```{code} bash
|
||||||
|
sudo apt update # update apt cache
|
||||||
|
sudo apt install curl
|
||||||
|
```
|
||||||
|
|
||||||
## 1. Install Funkwhale dependencies
|
## 1. Install Funkwhale dependencies
|
||||||
|
|
||||||
To install Funkwhale on your server, you first need to install its dependencies. We provide all dependencies in a single file to enable you to install everything at once. You can pass the information from this file to `apt` using the following command:
|
To install Funkwhale on your server, you first need to install its dependencies. We provide all dependencies in a single file to enable you to install everything at once. You can pass the information from this file to `apt` using the following command:
|
||||||
|
|
|
@ -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 [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
|
## 1. Download the project files
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,22 @@
|
||||||
# Install Funkwhale on your server
|
# 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}
|
```{toctree}
|
||||||
---
|
---
|
||||||
caption: Choose your installation method
|
caption: Choose your installation method
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
debian/index
|
quick_install/index
|
||||||
docker/index
|
docker/index
|
||||||
|
debian/index
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -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.
|
Loading…
Reference in New Issue