https://github.com/PhaserEditor2D/SimpleStaticServer
A very simple HTTP server for static content (HTML5 games, single page applications).
https://github.com/PhaserEditor2D/SimpleStaticServer
Last synced: about 1 month ago
JSON representation
A very simple HTTP server for static content (HTML5 games, single page applications).
- Host: GitHub
- URL: https://github.com/PhaserEditor2D/SimpleStaticServer
- Owner: PhaserEditor2D
- License: mit
- Created: 2021-07-01T05:50:49.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-08T15:01:51.000Z (almost 4 years ago)
- Last Synced: 2024-05-20T03:18:31.769Z (11 months ago)
- Language: Go
- Size: 10.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
- cuban-opensource - SimpleStaticServer - configuration server for static files. Optimized for HTML5 games and Single Page Applications. Made with Go. (Docker / Telegram)
README
# Simple Static Server
This is a very simple HTTP server for serving static content. For example, for serving HTML5 games and single page applications.
## Download
Get the `SimpleStaticServer` binaries form the [latest release](https://github.com/PhaserEditor2D/SimpleStaticServer/releases).
## Usage
By default, the server listens at port `1999` and serves the current directory.
You can change these values with the arguments:
```
SimpleStaticServer -port 80 -dir /path/to/public
```
## Features
This server has zero configuration (except the `port` and `dir` variables). It servers a single application (probably running in a container).
### Cache control
All content is cached by the browser (with the exception of the root file -`/index.html`-).
This means that all responses include the header:
```
Cache-Control: public, max-age=31104000, immutable
```
Only the request to the root file generates a response with the header:
```
Cache-Control: no-store
```
This feature is useful for single page apps built with tools like Webpack. Webpack can generate a different name for a file when the file is modified. So, it is safe to cache every file requested to the server.
### File not found
If a file is not found, it internally redirects to the `/index.html` file.
This is required for single page applications with URL routers running in the browser.
For example, Angular apps.
This server is implemented in Go, and uses the `net/http` package.
### Gzip
The files with these content types are gzip-compressed:
```
text/plain
text/html
text/css
text/csv
text/javascript
text/json
text/xml
application/json
application/xml
application/vnd.ms-fontobject
font/otf
font/ttf
font/woff
font/woff2
image/svg+xml
```
## Build
Just run the `build.sh` script. It produces the `dist/SimpleStaticServer` binary file.