Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anime-skip/remote-config
Simple HTTP remote config server
https://github.com/anime-skip/remote-config
aws-s3 docker go vue3
Last synced: 28 days ago
JSON representation
Simple HTTP remote config server
- Host: GitHub
- URL: https://github.com/anime-skip/remote-config
- Owner: anime-skip
- License: mit
- Created: 2021-11-23T17:07:58.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-17T15:23:27.000Z (over 2 years ago)
- Last Synced: 2024-11-07T18:43:09.159Z (3 months ago)
- Topics: aws-s3, docker, go, vue3
- Language: Go
- Homepage: https://remote-config.anime-skip.com
- Size: 91.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# remote-config
This is a lightweight and simple remote config server with a UI for management backed by AWS S3.
The backend API (Go) serves a frontend (Vue) and HTTP endpoints.
> I wrote this because I don't want to pay for another service and Firebase doesn't work all the time in web extensions :/
## Get Started
1. Create S3 Bucket
1. Build the docker image
1. Deploy the docker image
That's it!
### 1. Create S3 Bucket
You can create the S3 bucket however you like. Or you can use an existing one.
See AWS's docs if you've never done this before:
### 2. Build the docker image
Eventually, I'm going to publish this image to docker hub. Until then, build and tag the image yourself:
```bash
git clone [email protected]:anime-skip/remote-config.git
docker build . -t my-remove-config
```
### 3. Deploy the docker image
You will have to self host this docker image. AWS, Heroku, GoogleCloud, anywhere that supports deploying docker images will work.
Make sure you provide all the [environment variables](#environment-variables) however your hosting provider allows.
---
## Docs
### Environment Variables
| Variable | Required | Default | Example | Description |
| :-------------------- | :------: | :-----: | :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| PORT | ✅ | --- | `80`, `8080` | The port to run the application on |
| AUTH_TOKEN | ✅ | --- | `password` | The token used to authenticate changes to the remove config. Config is viewable by everyone, but only writable if you know the token |
| AWS_REGION | ✅ | --- | `us-east-1` | The AWS region your bucket is in |
| AWS_ACCESS_KEY_ID | ✅ | --- | | See [AWS Docs](https://aws.github.io/aws-sdk-go-v2/docs/getting-started/#get-your-aws-access-keys) |
| AWS_SECRET_ACCESS_KEY | ✅ | --- | | See [AWS Docs](https://aws.github.io/aws-sdk-go-v2/docs/getting-started/#get-your-aws-access-keys) |
| S3_BUCKET | ✅ | --- | `remote-config` | The name of the bucket used as storage |
| S3_FILE_PATH | ✅ | --- | `dev.json`, `prod.json`, `path/to/my-file.json` | The path to the file in your bucket. The file can be named whatever, as long as it ends with `.json`, and the path can excluded or point to any subdirectory. Missing directories will be created |
### API Docs
[HTTPie](https://httpie.io/) is used for example calls because it's easier to read and understand compared to curl.
> `http -b` prints just the response body.
#### `GET /api/apps`
List all the apps you have created remote config for.
```bash
$ http -b "remote-config.anime-skip.com/api/apps"
[
"Anime Skip Player",
"anime-skip.com"
]
```
#### `GET /api/config/{app}`
Get the current config for an app.
```bash
$ http -b "remote-config.anime-skip.com/api/config/anime-skip.com"
{
"array": [
1,
null,
"string"
],
"number": 69,
"object": {
"key": "value"
},
"optional": null,
"string": "test"
}
```
#### `PUT /api/config/{app}`
Create or update the config for a given app name, returning the updated config.
**Requires `Authorization: Bearer ` header**
```bash
$ http -b -A bearer -a "" PUT "remote-config.anime-skip.com/api/config/example" key=value
{
"key": "value"
}
```
#### `DELETE /api/config/{app}`
Delete an app's config, returning the deleted config
**Requires `Authorization: Bearer ` header**
```bash
$ http -b -A bearer -a "" DELETE "remote-config.anime-skip.com/api/config/example"
{
"key": "value"
}
```
---
## Other Tools
- JS client with caching and a synchronous API, based off Firebase: