diff --git a/README.md b/README.md index 62b8e606..4f4e8c27 100644 --- a/README.md +++ b/README.md @@ -12,65 +12,54 @@ filebrowser provides a file managing interface within a specified directory and # Table of contents -+ [Getting started](#getting-started) ++ [Quick Start](#quick-start) + [Features](#features) - - [Users](#users) - - [Search](#search) ++ [Installation](#installation) + - [One-step script](#one-step-script) + - [Docker](#docker) ++ [Usage](#usage) ++ [Command line interface](#command-line-interface) + [Contributing](#contributing) -+ [Donate](#donate) -# Getting started +# Quick Start -You can find the Getting Started guide on the [documentation](https://filebrowser.github.io/quick-start/). +The fastest way for beginners to start using File Browser is by following the instructions bellow. Although, there are [other ways](#installation) to install/use it. + +- [Download File Browser](https://github.com/filebrowser/filebrowser/releases). +- Put the binary in your PATH. +- Run `filebrowser -s /path/to/your/files`. + +Done! It will tell you the address in which File Browser is running. You only need to open it and use the following credentials (you should change them!): + +- Username: ```admin``` +- Password: ```admin``` + +Although this is the fastest way to run File Browser, we recommend you to take a look at its [usage](#usage) as it contains more information about what you can do. # Features -Easy login system. +# Installation -![Login Page](https://user-images.githubusercontent.com/5447088/42046516-fe702976-7af5-11e8-9d72-c996150b09f5.png) +## One-step script -Listings of your files, available in two styles: mosaic and list. You can delete, move, rename, upload and create new files, as well as directories. Single files can be downloaded directly, and multiple files as *.zip*, *.tar*, *.tar.gz*, *.tar.bz2* or *.tar.xz*. +If you're running a Linux distribution or macOS, 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`. -![Mosaic Listing](https://user-images.githubusercontent.com/5447088/42046515-fe3f7d58-7af5-11e8-8f87-270947ed755f.png) - -File Browser editor is powered by [Codemirror](https://codemirror.net/) and if you're working with markdown files with metadata, both parts will be separated from each other so you can focus on the content. - -![Markdown Editor](https://user-images.githubusercontent.com/5447088/42046519-ff17b81c-7af5-11e8-90f3-184e0ad24b7c.png) - -On the settings page, a regular user can set its own custom CSS to personalize the experience and change its password. For admins, they can manage the permissions of each user, set commands which can be executed when certain events are triggered (such as before saving and after saving) and change plugin's settings. - -![Settings](https://user-images.githubusercontent.com/5447088/42046517-fea206e4-7af5-11e8-88fe-b88513b43f43.png) - -We also allow the users to search in the directories and execute commands if allowed. - -## Users - -We support multiple users and each user can have its own scope and custom stylesheet. The administrator is able to choose which permissions should be given to the users, as well as the commands they can execute. Each user also have a set of rules, in which he can be prevented or allowed to access some directories (regular expressions included!). - -![Users](https://user-images.githubusercontent.com/5447088/42046518-fed14440-7af5-11e8-9a57-f4a611e9598d.png) - -## Search - -File Browser allows you to search through your files and it has some options. By default, your search will be something like this: - -``` -this are keywords +```shell +curl -fsSL https://filebrowser.github.io/get.sh | bash ``` -If you search for that it will look at every file that contains "this", "are" or "keywords" on their name. If you want to search for an exact term, you should surround your search by double quotes: +If you're on Windows, you can use PowerShell to install File Browser too. You should run the command as administrator because it needs perissions to add the executable to the PATH: -``` -"this is the name" +```shell +iwr -useb https://filebrowser.github.io/get.ps1 | iex ``` -That will search for any file that contains "this is the name" on its name. It won't search for each separated term this time. +## Docker -By default, every search will be case insensitive. Although, you can make a case sensitive search by adding `case:sensitive` to the search terms, like this: +# Usage -``` -this are keywords case:sensitive -``` +# Command line interface # Contributing -The contributing guidelines can be found [here](https://github.com/filebrowser/community). \ No newline at end of file +The contributing guidelines can be found [here](https://github.com/filebrowser/community).