Updated Installation (markdown)

master
Henrique Dias 2018-12-30 18:06:39 +00:00
parent 3f23d6947f
commit 57baf17647
1 changed files with 83 additions and 1 deletions

@ -1 +1,83 @@
# One Step Script There are some different ways you can use to install File Browser on your computer or server. You can choose on the following. After having it installed, take a look at the [configuration](../configuration).
## One-step Script
If you're running a Linux distribution, macOS or any other platform where `curl` or `wget` commands are available, you can use our special script - made by [Kyle Frost](https://www.kylefrost.me/) - to download the latest version of File Browser and install it on `/usr/local/bin`.
With curl:
```shell
curl -fsSL https://filebrowser.github.io/get.sh | bash
```
Or using wget:
```
wget -qO- https://filebrowser.github.io/get.sh | bash
```
If you're on Windows, you can use PowerShell to install File Browser too. You should run the following command as administrator since it needs permissions to add the executable to the PATH:
```
iwr -useb https://filebrowser.github.io/get.ps1 | iex
```
## Caddy
The easiest way to get started is using this with Caddy web server. You just need to download Caddy from its [official website](https://caddyserver.com/download) with `http.filemanager` plugin enabled. For more information about the plugin itself, please refer to its [documentation](https://caddyserver.com/docs/http.filemanager).
If you're building Caddy from source, you should import `github.com/filebrowser/caddy/filemanager` for File Browser, `github.com/filebrowser/caddy/hugo` for Hugo and `github.com/filebrowser/caddy/jekyll` for Jekyll.
## Docker
File Browser is also available on Docker through [Docker Hub](https://hub.docker.com/r/filebrowser/filebrowser/). To install it, run:
```
docker pull filebrowser/filebrowser
```
The paths you need to bind to do your own configuration are:
- Config: `/etc/config.json`
- Database: `/etc/database.db`
- Base scope: `/srv`
By default, the image uses the configuration file (which is also our recommendation). The **defaults** are:
```json
{
"port": 80,
"address": "",
"database": "/etc/database.db",
"scope": "/srv",
"allowCommands": true,
"allowEdit": true,
"allowNew": true,
"commands": []
}
```
Using the configuration file:
```shell
docker run \
-v /path/to/sites/root:/srv \
-v /path/to/config.json:/config.json \
-v /path/to/database.db:/database.db \
-p 80:80 \
filebrowser/filebrowser
```
Using command line arguments:
```shell
docker run \
-v /path/to/sites/root:/srv \
-v /path/to/database.db:/database.db \
-p 80:80 \
filebrowser/filebrowser
--port 80
--database /database.db
--scope /srv
--other-flag other-value
```