Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yookoala/goserve-media
A no-brainer media server to serve a single folder to the web
https://github.com/yookoala/goserve-media
Last synced: 5 days ago
JSON representation
A no-brainer media server to serve a single folder to the web
- Host: GitHub
- URL: https://github.com/yookoala/goserve-media
- Owner: yookoala
- License: gpl-3.0
- Created: 2015-06-18T14:23:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-06-19T12:43:06.000Z (over 9 years ago)
- Last Synced: 2024-10-23T22:51:07.870Z (about 2 months ago)
- Language: Go
- Size: 133 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
goserve
=======
`goserve` is a small utility to serve static HTML files in a directory to a given port.
It is intented for developer who wants a quick access to their code through browser. Especially so when their code are not using relative path in link / image / CSS what so ever. Just compile the binary and put it in your `PATH`, then it is good to go.
The code is dead simple. I simply don't want to write it all the time. And I wish it might be of help to you, too.
Requirement
-----------
`goserve` requires only the core go libraries. No need to `go get` anything other than this.
Installation
------------
If you have set `GOPATH/bin` to your `PATH`, you may install and use this by:
```sh
go get github.com/yookoala/goserve
```
Alternatively, you may compile and copy the binary to your directory in `PATH`.
```sh
git clone https://github.com/yookoala/goserve.git
cd goserve
go build
cp goserve YOUR_DIR_IN_PATH/.
```
Usage
-----
Just type this, a server will be serving the files in the current directory to default port 8080:
```sh
goserve
```
To specify the directory, you may add 1 directory path as the argument:
```sh
goserve ./data
```
You may specify the port with environment variable `PORT`:
```sh
PORT=8123 goserve ./data
```
You may manually override the default or `PORT` with `-port` parameter:
```sh
goserve -port=8123 ./data
```
Author
------
This software is written by [Koala Yeung](https://github.com/yookoala) (koalay at gmail.com).
Licence
-------
This software is licenced under GPL v3. You may obtain a copy of the licence in the `LICENSE` file in this repository.
Bug Report
----------
You are always welcome to report issue here:
https://github.com/yookoala/goserve/issues