https://github.com/ericfrancis12/tree-server
Serve Files at Lightning Speed according to the Tree Structure of your File System
https://github.com/ericfrancis12/tree-server
file fileserver filesystem go golang server
Last synced: 22 days ago
JSON representation
Serve Files at Lightning Speed according to the Tree Structure of your File System
- Host: GitHub
- URL: https://github.com/ericfrancis12/tree-server
- Owner: EricFrancis12
- License: mit
- Created: 2024-06-11T02:15:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T15:33:16.000Z (almost 2 years ago)
- Last Synced: 2025-03-01T08:53:41.651Z (over 1 year ago)
- Topics: file, fileserver, filesystem, go, golang, server
- Language: Go
- Homepage: https://hub.docker.com/repository/docker/ericfrancis12/tree-server/general
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tree Server
Serve Files at Lightning Speed according to the Tree Structure of your File System
## Diagram
```base
$ ./tree-server.exe --PORT=3000
|-- Documents
|-- spreadsheets
|-- third-quarter-report.csv --> http://localhost:3000/Documents/spreadsheets/third-quarter-report.csv
|-- Pictures
|-- family-photos
|-- first-birthday.jpeg --> http://localhost:3000/Pictures/family-photos/first-birthday.jpeg
|-- screenshots
|-- screenshot.png --> http://localhost:3000/Pictures/screenshots/screenshot.png
```
## Getting Started
Make sure you have [Go](https://go.dev/doc/install) installed.
Clone the repo:
```
git clone https://github.com/EricFrancis12/tree-server.git
```
```
cd tree-server
```
### Option A: Quickstart (Run the Application without building)
Run the following command, optionally specifying a port (PORT) and working directory (WD):
```
go run . --PORT=3000 --WD=./
```
In the example above, `--WD=./` means the contents of this repo will be served on port 3000.
### Option B: Build and Run
Run the following command:
```
go build .
```
This will create a binary file located at `./tree-server`.
Run the binary, optionally specifying a port (PORT) and working directory (WD).
Note that if no working directory is specified, the working directory will be the location where the binary is ran. This means you can copy the binary to anywhere in the file system to serve its contents.
```
./tree-server --PORT=3000 --WD=./
```
### Option C: Run via Docker
Make sure you have [Docker](https://docs.docker.com/engine/install) installed.
Build the Docker Image:
```
docker build -t tree-server .
```
Run it using the following command:
```
docker run -p 3000:3000 -v .:/app/serve --name tree-server tree-server
```
The contents of the `/app/serve` directory located inside the container will be served. To bind `/app/serve` to a directory on your local machine, use a bind mount. In the above command, we are binding the current local directory `.` to the `/app/serve` directory.
For more information on bind mounts, [click here](https://docs.docker.com/storage/bind-mounts/).
For more information on port mapping using the `-p` flag, [click here](https://docs.docker.com/network/#published-ports)
## Using the Application
Once the Application is running, visit it at your chosen port:
[http://localhost:3000](http://localhost:3000)
### Downloading files
Use `dl=1` or `download=1` to download the file if it exists.
Example: http://localhost:3000/my/file.txt?dl=1