🌱 Mikochi: a minimalist remote file browser

Mikochi is a remote file browser, for use in self-hosted servers / NAS. It allows you to browse remote folders, upload files, delete, rename, download and stream files to VLC/mpv.

It comes with a web interface powered by JavaScript/Preact, and an API built in Go/Gin.

https://github.com/zer0tonin/Mikochi/assets/7149690/3cac61a6-d547-4adb-bd4b-0c312ff0c8c1

Features

Browse files on you remote server
Fuzzy search
Upload new files and create folders
Rename and delete files
Download files and directories (in .tar.gz)
Stream files to VLC/MPV

Getting started

Docker

Launch the app using docker:

docker run \
-p 8080:8080 -v $(PWD)/data:/data \
-e DATA_DIR="/data" -e USERNAME=zer0tonin \
-e PASSWORD=horsebatterysomething zer0tonin/mikochi:latest

You'll find a complete tutorial on installing Mikochi securely with Docker and Traefik here.

Kubernetes

For Kubernetes users, Mikochi is installable using a helm chart:

helm repo add zer0tonin https://zer0tonin.github.io/helm-charts/
helm install mikochi zer0tonin/mikochi \
--version 1.6.0 --set mikochi.username=zer0tonin \
--set mikochi.password=my_super_password --set persistence.enabled=true

Binary

Launch the app using a pre-compiled binary from the latest release:

wget -c https://github.com/zer0tonin/Mikochi/releases/download/1.6.0/mikochi-linux-amd64.tar.gz -O - | tar -xz
HOST=127.0.0.1:8080 USERNAME=zer0tonin PASSWORD=horsebatterysomething ./app/mikochi

Configuration

Mikochi is configured using environment variables

Key	Description	Default
HOST	The ip:port mikochi will listen on	0.0.0.0:80
DATA_DIR	The directory accessed by mikochi	/data
JWT_SECRET	A secret string for jwt validation	[Random]
USERNAME	The username to login with	root
PASSWORD	The password to login with	pass
CERT_CA	The path to a TLS certificate	null
CERT_KEY	The path to the key associated with CERT_CA	null
NO_AUTH	If true, disables all authentication	false
GZIP	If true, enables gzip compression	false

Note: it is recommended to not manually set JWT_SECRET, as getting a new randomly generated secret everytime when mikochi starts let's you invalidate authentication tokens by restarting the process.

Launching the development environment

The development environment and build pipeline rely on Docker/docker-compose.

Run the dockerized development environment with:

make dev

It will start a frontend container (listening on 5000), a backend container (listening on 4000) and an nginx to wire both (listening on 8080).

zer0tonin / Mikochi

readme