Skip to content

Quick Start

There are several ways to set up FolderHost. You can start using it by pulling Docker image or downloading the binary from GitHub.

⚠️ Warning: Don't forget to change admin password from config.yml, after first start.

Windows

Download the latest release, create a directory on your computer then extract the archive inside it. Double-click the executable file and make sure that config.yml appears. After that, edit config.yml file, change the admin password! You can now start it normally!

Linux

Just copy and paste these commands, and FolderHost will start working. It's around 23 MB.

sh
wget https://github.com/MertJSX/folderhost/releases/latest/download/folderhost-linux-amd64.zip
unzip folderhost-linux-amd64.zip
chmod +x folderhost

# Run it once to generate the config.yml file, then edit it.
./folderhost

Docker

Open your terminal, paste this command, and you're ready to use it! Open http://localhost:5000 and start using it!

sh
# Run container, you can access the files using Docker volumes
  docker run -d \
    --name folderhost-server \
    -p 5000:5000 \
    -v folderhost_data:/app \
    --restart unless-stopped \
    mertjsx/folderhost:latest

Docker compose

First pull the latest Docker image.

sh
docker pull mertjsx/folderhost:latest

Create a file with name docker-compose.yml then paste the code below. You can edit it according to your needs.

yml
services:
  folderhost:
    image: mertjsx/folderhost:latest
    container_name: folderhost-server
    ports:
      - "5000:5000"  # Change to match your config.yml port
    volumes:
      - folderhost_data:/app
    restart: unless-stopped
    
volumes:
  folderhost_data:

Then run the following command inside the directory where the docker-compose.yml file is located and you're ready to go:

sh
docker-compose up -d