Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qdm12/srv
srv is a small Go application to server static files over HTTP
https://github.com/qdm12/srv
Last synced: about 2 months ago
JSON representation
srv is a small Go application to server static files over HTTP
- Host: GitHub
- URL: https://github.com/qdm12/srv
- Owner: qdm12
- License: mit
- Created: 2021-06-06T13:48:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-16T06:04:41.000Z (over 1 year ago)
- Last Synced: 2024-06-21T15:41:33.053Z (3 months ago)
- Language: Go
- Size: 138 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# SRV
*srv is a small Go application to use as a container or as a base Docker image in other projects to serve static files over HTTP*
[](https://github.com/qdm12/srv/actions?query=workflow%3ACI)
[](https://hub.docker.com/r/qmcgaw/srv)
[](https://hub.docker.com/r/qmcgaw/srv)
[](https://microbadger.com/images/qmcgaw/srv)
[](https://microbadger.com/images/qmcgaw/srv)
[](https://join.slack.com/t/qdm12/shared_invite/enQtOTE0NjcxNTM1ODc5LTYyZmVlOTM3MGI4ZWU0YmJkMjUxNmQ4ODQ2OTAwYzMxMTlhY2Q1MWQyOWUyNjc2ODliNjFjMDUxNWNmNzk5MDk)
[](https://github.com/qdm12/srv/commits/main)
[](https://github.com/qdm12/srv/graphs/contributors)
[](https://github.com/qdm12/srv/issues)
## Features
- Compatible with `amd64`, `386`, `arm64`, `arm32v7`, `arm32v6`, `ppc64le`, `s390x` and `riscv64` CPU architectures
- Runs without root as user ID `1000`
- Based on the `scratch` docker image for a tiny size of 9.11MB (uncompressed amd64 image)
- [Docker image tags and sizes](https://hub.docker.com/r/qmcgaw/srv/tags)
- Prometheus metrics available on `:9091`
## Setup
### As a container
We assume your static files are at `/yourpath` on your host.
1. Ensure the ownership of your static files matches the ones from the container:
```sh
chown -R 1000 /yourpath
```
1. Run the container, bind mounting `/yourpath` to `/srv` as ready only:
```sh
docker run -d -p 8000:8000/tcp -v /yourpath:/srv:ro qmcgaw/srv
```
You can also use [docker-compose.yml](https://github.com/qdm12/srv/blob/main/docker-compose.yml) with:
```sh
docker-compose up -d
```
1. You can update the image with `docker pull qmcgaw/srv` or use one of the [tags available](https://hub.docker.com/r/qmcgaw/srv/tags)
### As a base image
You can use it in your own project with:
```Dockerfile
FROM qmcgaw/srv
COPY --chown=1000 srv /srv
```
Or with a multi stage Dockerfile:
```Dockerfile
FROM someimage AS staticbuilder
COPY . .
RUN somecompiler --output-to=/tmp/build
FROM qmcgaw/srv
COPY --from=staticbuilder --chown=1000 /tmp/build /srv
```
### Environment variables
| Environment variable | Default | Possible values | Description |
| --- | --- | --- | --- |
| `HTTP_SERVER_ADDRESS` | `:8000` | Valid address | HTTP server listening address |
| `HTTP_SERVER_ROOT_URL` | `/` | URL path | HTTP server root URL |
| `HTTP_SERVER_LOG_REQUESTS` | `on` | `on` or `off` | Log requests and responses information |
| `FILEPATH_SRV` | `/srv` | Valid file path | File path to your static files directory |
| `METRICS_SERVER_ADDRESS` | `:9090` | Valid address | Prometheus HTTP server listening address |
| `LOG_LEVEL` | `info` | `debug`, `info`, `warning`, `error` | Logging level |
| `HEALTH_SERVER_ADDRESS` | `127.0.0.1:9999` | Valid address | Health server listening address |
| `TZ` | `America/Montreal` | *string* | Timezone |
## Development
1. Setup your environment
Using VSCode and Docker (easier)
1. Install [Docker](https://docs.docker.com/install/)
- On Windows, share a drive with Docker Desktop and have the project on that partition
- On OSX, share your project directory with Docker Desktop
1. With [Visual Studio Code](https://code.visualstudio.com/download), install the [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
1. In Visual Studio Code, press on `F1` and select `Remote-Containers: Open Folder in Container...`
1. Your dev environment is ready to go!... and it's running in a container :+1: So you can discard it and update it easily!
Locally
1. Install [Go](https://golang.org/dl/), [Docker](https://www.docker.com/products/docker-desktop) and [Git](https://git-scm.com/downloads)
1. Install Go dependencies with
```sh
go mod download
```
1. Install [golangci-lint](https://github.com/golangci/golangci-lint#install)
1. You might want to use an editor such as [Visual Studio Code](https://code.visualstudio.com/download) with the [Go extension](https://code.visualstudio.com/docs/languages/go). Working settings are already in [.vscode/settings.json](https://github.com/qdm12/srv/main/.vscode/settings.json).
1. Commands available:
```sh
# Build the binary
go build cmd/app/main.go
# Test the code
go test ./...
# Lint the code
golangci-lint run
# Build the Docker image
docker build -t qmcgaw/srv .
```
1. See [Contributing](https://github.com/qdm12/srv/main/.github/CONTRIBUTING.md) for more information on how to contribute to this repository.
## License
This repository is under an [MIT license](https://github.com/qdm12/srv/main/license) unless otherwise indicated