https://github.com/jcoupalk/flyserve
FlyServe is a simple web server written in Go, designed to serve files and directories over HTTP quickly and without hassle for file sharing.
https://github.com/jcoupalk/flyserve
file-listing file-sharing golang http http-server web-server
Last synced: about 2 months ago
JSON representation
FlyServe is a simple web server written in Go, designed to serve files and directories over HTTP quickly and without hassle for file sharing.
- Host: GitHub
- URL: https://github.com/jcoupalk/flyserve
- Owner: JCoupalK
- License: mit
- Created: 2024-02-11T12:23:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-31T15:13:13.000Z (2 months ago)
- Last Synced: 2025-03-31T16:38:57.736Z (2 months ago)
- Topics: file-listing, file-sharing, golang, http, http-server, web-server
- Language: Go
- Homepage: https://jcoupal.com
- Size: 26.4 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FlyServe
FlyServe is a simple web server written in Go, designed to serve files and directories over HTTP quickly and without hassle for file sharing. It provides features such as serving specific files (including a website if HTML), serving directories, basic authentication, and directory listings.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Building from Source](#building-from-source)
- [Usage](#usage)
- [Examples](#examples)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [License](#license)
## Features
- Serve specific files
- Serve directories with directory listings
- Basic authentication support
- Customizable port number
- Single binary, no external dependencies
## Installation
1. Download the binary with wget:
```shell
wget https://github.com/JCoupalK/FlyServe/releases/download/1.0/flyserve_linux_amd64_1.0.tar.gz
```
2. Unpack it with tar
```shell
tar -xf flyserve_linux_amd64_1.0.tar.gz
```
3. Move it to your /usr/local/bin/ (Optional):
```shell
sudo mv flyserve /usr/local/bin/flyserve
```
## Building from Source
1. Ensure you have Go installed on your system. You can download Go from [here](https://golang.org/dl/).
2. Clone the repository:
```shell
git clone https://github.com/JCoupalK/FlyServe
```
3. Navigate to the cloned directory:
```shell
cd FlyServe
```
4. Build the tool:
```shell
go build -o flyserve .
```
## Usage
Options:
```txt
-p, --port Port to serve on (Default is 8080)
-f, --file Specific file to serve
-d, --directory Directory to serve files from (Default is current directory)
-u, --username Username for basic authentication
-pw, --password Password for basic authentication
-h, --html Enable auto-resolution of .html files
```
## Examples
```bash
# Serve files from the current directory on port 8080
flyserve
# Serve files from a specific directory on port 9000
flyserve -d /path/to/directory -p 9000
# Serve a specific file on port 8080 with basic authentication
flyserve -f /path/to/file.txt -u username -pw password
# Serve websites by just specifying a directory that contains an index.html
flyserve -d /path/to/website -p 80 -h
```
## Screenshots
## Contributing
Contributions are welcome. If you find a bug or have a feature request, please open an issue or submit a pull request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.