Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zer0tonin/Mikochi
A minimalist file-manager with streaming capabilities
https://github.com/zer0tonin/Mikochi
file-manager go preact self-hosted
Last synced: about 2 months ago
JSON representation
A minimalist file-manager with streaming capabilities
- Host: GitHub
- URL: https://github.com/zer0tonin/Mikochi
- Owner: zer0tonin
- License: mit
- Created: 2023-01-10T17:35:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-14T18:08:28.000Z (5 months ago)
- Last Synced: 2024-01-14T22:59:53.032Z (5 months ago)
- Topics: file-manager, go, preact, self-hosted
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 123
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-selfhosted - mikochi - Browse remote folders, upload files, delete, rename, download and stream files to VLC/mpv. `MIT` `Go/Docker/K8S` (Software / File Transfer - Web-based File Managers)
- fucking-awesome-selfhosted - mikochi - Browse remote folders, upload files, delete, rename, download and stream files to VLC/mpv. `MIT` `Go/Docker/K8S` (Software / File Transfer - Web-based File Managers)
- awesome-selfhosted - mikochi - Browse remote folders, upload files, delete, rename, download and stream files to VLC/mpv. `MIT` `Go/Docker/K8S` (Software / File Transfer - Web-based File Managers)
README
# 🌱 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.
## Getting started
### Docker
Launch the app using [docker](https://hub.docker.com/r/zer0tonin/mikochi):
```sh
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](https://alicegg.tech/2024/01/04/mikochi-tutorial).
### Kubernetes
For Kubernetes users, Mikochi is installable using a [helm chart](https://artifacthub.io/packages/helm/zer0tonin/mikochi):
```sh
helm repo add zer0tonin https://zer0tonin.github.io/helm-charts/
helm install mikochi zer0tonin/mikochi \
--version 1.4.5 --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](https://github.com/zer0tonin/Mikochi/releases):
```sh
wget -c https://github.com/zer0tonin/Mikochi/releases/download/1.4.5/mikochi-linux-amd64.tar.gz -O - | tar -xz
HOST=127.0.0.1:8080 USERNAME=zer0tonin PASSWORD=horsebatterysomething ./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 |
## Launching the development environment
The development environment and build pipeline rely on Docker/docker-compose.
Run the dockerized development environment with:
```sh
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).
Use `make build` to run a production build in a single container.