Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/5ht2/srp-go
Serve random pictures on a domain, with upload and browse support
https://github.com/5ht2/srp-go
docker fasthttp filesystem go http http-server
Last synced: about 1 month ago
JSON representation
Serve random pictures on a domain, with upload and browse support
- Host: GitHub
- URL: https://github.com/5ht2/srp-go
- Owner: 5HT2
- License: isc
- Created: 2021-07-07T15:38:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T07:08:58.000Z (10 months ago)
- Last Synced: 2024-06-20T12:52:46.877Z (7 months ago)
- Topics: docker, fasthttp, filesystem, go, http, http-server
- Language: Go
- Homepage: https://frog.pics
- Size: 3.16 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# [srp-go](https://frog.pics)
[](https://wakatime.com/badge/github/5HT2/srp-go)
[](https://hub.docker.com/r/l1ving/srp-go)
[](https://github.com/5HT2/srp-go/actions/workflows/docker-build.yml)
[](https://www.codefactor.io/repository/github/5HT2/srp-go)
Serve a random image on [\](https://frog.pics) with a dynamic background color, let users upload
on [/upload](https://frog.pics/upload) and browse a gallery on [/browse](https://frog.pics/browse). Has (optional) image
resizing and compression.
Contributions are welcome and appreciated.
## Contributing
To build:
```bash
git clone [email protected]:5HT2/srp-go.git
cd srp-go
make
```
To run:
```bash
./srp-go -h # for a full list of parameters (none required)
./srp-go -addr=localhost:6060 -debug=true
```
I recommend deleting [`sample.jpg`](https://github.com/5HT2/srp-go/blob/master/config/images/sample.jpg)
after you have uploaded a few pictures. The sample file is there to prevent issues when first testing
(needing an image to serve on `/`, to generate a sample color for, etc).
You can also add your own `favicon.ico` inside the `config/` directory, and it will overwrite the default icon.
## OAuth
In order to set up OAuth, follow [these](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app)
instructions to create a GitHub OAuth app.
You will want to
- Set `LIVE_URL` to the accessible url of your site in (`.env`)
- Eg: `https://frog.pics`
- Or: `http://localhost:6060` for a testing environment
- Set the Callback URL to your `LIVE_URL` + `/api/auth/callback`
- Enable "Request user authorization (OAuth)"
- You do not need to enable permissions for anything
Create a `.env` file inside your config folder, with the following format:
```bash
OAUTH_CLIENT_ID=Iv1.some_client_id
OAUTH_CLIENT_SECRET=your_client_secret
LIVE_URL=http://localhost:6060
BROWSE_PAGE_COLOR= # optional color code to use for the /browse page
WEBHOOK_URL= # optional discord webhook url for posting specific events
```
## API
The full list of accessible API endpoints can be found inside [`api.go`](https://github.com/5HT2/srp-go/blob/master/api.go).
The `/api/all` endpoint will give you a list of all available images, in the below json format.
The `/api/random` endpoint will return the properties of a randomly-selected image in json (by default), like so:
```json
{
"image_name": "sample.jpg",
"image_url": "http://localhost:6060/images/sample.jpg",
"median_color": "868232"
}
```
You can also add `?format=css` to get the css version if you really want:
```css
body {
background-color: #868232;
}
div.img {
content: url('/images/sample.jpg');
}
```
## TODO:
- [x] Add authentication for uploading
- [ ] Add Discord embeds
- [ ] Switch to a different prominent color library, because the current one doesn't support webp
- [ ] Switch to webp for saving images
- [ ] Finalize webhook support
- [ ] Image attribution support
- [x] Sign In button broke
## License
This project is licensed under [ISC](https://github.com/5HT2/srp-go/blob/master/LICENSE.md).
The [`sample.jpg`](https://github.com/5HT2/srp-go/blob/master/config/images/sample.jpg) file is licensed under
Creative Commons Attribution-Share Alike, you can find the original file
[here](https://commons.wikimedia.org/wiki/File:Bufo_americanus_PJC1.jpg).