GitBook: [master] 41 pages modified

Author: o1egl

README.md

@@ -8,7 +8,7 @@ Welcome to File Browser's official documentation. Here you can find probably any
 
 We focus on doing one thing, but doing it well. One of the crucial pieces of File Browser is our community which is always asking us for new features or reporting issues that might happen. We recommend you vividly to check our [GitHub repository](https://github.com/filebrowser/filebrowser).
 
-{% page-ref page="installation/" %}
+{% page-ref page="installation.md" %}
 
 {% page-ref page="cli/" %}
 

SUMMARY.md

@@ -2,8 +2,7 @@
 
 * [Welcome](README.md)
 * [Features](features.md)
-* [Installation](installation/README.md)
-  * [Caddy](installation/caddy.md)
+* [Installation](installation.md)
 * [Upgrade from 1.x](upgrade-from-1.x.md)
 * [Command Line Interface](cli/README.md)
   * [filebrowser](cli/filebrowser.md)

configuration/README.md

@@ -8,5 +8,3 @@ Most of the configuration can be understood through our Command Line Interface d
 
 {% page-ref page="command-runner.md" %}
 
-
-

configuration/authentication-method.md

@@ -21,7 +21,7 @@ filebrowser config set --auth.method=json \
 By default, we use [Google's reCAPTCHA](https://developers.google.com/recaptcha/docs/display) service. If you live in China, or want to use other provider, you can change the host with the following command:
 
 ```bash
-filebrowser config set --recaptcha.host https://recaptcha.net 
+filebrowser config set --recaptcha.host https://recaptcha.net
 ```
 
 Where `https://recaptcha.net` is any provider you want.

contributing/README.md

@@ -63,5 +63,3 @@ To build File Browser is just like any other Go program:
 go build
 ```
 
-
-

contributing/ci-and-releases.md

@@ -18,5 +18,3 @@ We use semantic versioning. For more info check [semver.org](https://semver.org)
       2. The artifacts are published to [GitHub Releases](https://github.com/filebrowser/filebrowser/releases).
       3. The tagged docker image is published to [hub.docker.com/r/filebrowser/filebrowser](https://hub.docker.com/r/filebrowser/filebrowser/).
 
-
-

installation.md

@@ -0,0 +1,58 @@
+# Installation
+
+File Browser is a single binary and can be used as a standalone executable. Although, some might prefer to use it with [Docker](https://www.docker.com/) or [Caddy](https://caddyserver.com/), which is a fantastic web server that enables HTTPS by default. Its installation is quite straightforward independently on which system you want to use.
+
+## Quick Setup
+
+The quickest way for beginners to start using File Browser is by opening your terminal and executing the following commands:
+
+{% tabs %}
+{% tab title="Brew" %}
+```
+brew tap filebrowser/tap
+brew install filebrowser
+```
+{% endtab %}
+
+{% tab title="Unix" %}
+```bash
+curl -fsSL https://filebrowser.org/get.sh | bash
+filebrowser -r /path/to/your/files
+```
+{% endtab %}
+
+{% tab title="Windows" %}
+```bash
+iwr -useb https://filebrowser.org/get.ps1 | iex
+filebrowser -r /path/to/your/files
+```
+{% endtab %}
+{% endtabs %}
+
+Done! It will bootstrap a database in which all the configurations and users are stored. Now, you can see on your command line the address in which your instance is running. You just need to go to that URL and use the following credentials:
+
+* Username: `admin`
+* Password: `admin`
+
+{% hint style="danger" %}
+You must change the password and, if you can, the username for the best security possible.
+{% endhint %}
+
+Although this is the fastest way to bootstrap an instance, we recommend you to take a look at the possibility of options on [`init`](installation.md) and [`config set`](cli/filebrowser-config-set.md) to make the installation as safe and customized as it can be.
+
+## Docker
+
+File Browser is also available as a Docker image. You can find it on [Docker Hub](https://hub.docker.com/r/filebrowser/filebrowser). The usage is as follows:
+
+```bash
+docker run \
+    -v /path/to/root:/srv \
+    -v /path/filebrowser.db:/database.db \
+    -v /path/.filebrowser.json:/.filebrowser.json \
+    --user $(id -u):$(id -g)
+    -p 80:80 \
+    filebrowser/filebrowser
+```
+
+By default, we already have a [configuration file with some defaults](https://github.com/filebrowser/filebrowser/blob/master/.docker.json) so you can just mount the root and the database. Although you can overwrite by mounting a directory with a new config file. If you don't already have a database file, make sure to create a new empty file under the path you specified. Otherwise, Docker will create an empty folder instead of an empty file, resulting in an error when mounting the database into the container.
+