Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freepik-company/bifrost
A lightweight S3 proxy that re-signs requests between your customers and buckets, supporting multiple client authentication methods
https://github.com/freepik-company/bifrost
golang http s3 s3-proxy
Last synced: 26 days ago
JSON representation
A lightweight S3 proxy that re-signs requests between your customers and buckets, supporting multiple client authentication methods
- Host: GitHub
- URL: https://github.com/freepik-company/bifrost
- Owner: freepik-company
- License: apache-2.0
- Created: 2024-10-15T17:04:40.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-29T16:31:46.000Z (2 months ago)
- Last Synced: 2024-10-29T17:25:18.536Z (2 months ago)
- Topics: golang, http, s3, s3-proxy
- Language: Go
- Homepage:
- Size: 207 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bifrost
> [!IMPORTANT]
> This project is under active development. Some features may change without prior notice.
A lightweight S3 proxy that re-signs requests between your customers and buckets, supporting multiple client authentication methods.
## Motivation
Outbound traffic from S3 buckets is often expensive with many providers. Some providers treat outbound traffic as internal when it goes through alternative points other than the provided S3 endpoint, such as bare-metal machines.
In these situations, a transparent HTTP proxy isn't enough because all S3 client requests are signed at the source, and the signature includes the host. Simply rewriting this header doesn't help—the bucket will see the signature as invalid.
The simplest way to handle this is to intercept the request and re-sign it with valid data. This proxy is exactly the gateway you need.
## Diagram
## Flags
As almost every configuration parameter can be defined in environment vars, there are only few flags that can be defined.
They are described in the following table:
| Name | Description | Default | Example |
|:------------------|:-----------------------------------------------------|:--------------:|:-------------------------|
| `--log-level` | Verbosity level for logs | `info` | `--log-level info` |
| `--disable-trace` | Disable showing traces in logs | `info` | `--log-level info` |
| `--config` | Path to the configuration file
[Config Example] | `bifrost.yaml` | `--bifrost bifrost.yaml` |
| `--enable-periodic-cleanup` | Enable periodic memory cleanup | `false` | `--enable-periodic-cleanup` |
| `--periodic-cleanup-duration` | Duration for periodic memory cleanup | `4m` | `--periodic-cleanup-duration 5m` |
> Output is thrown always in JSON as it is more suitable for automations
```console
bifrost run \
--log-level=info
```
## Configuration
A complete example of the config params can be found in [docs/samples/bifrost.yaml](./docs/samples/bifrost.yaml)
## How to deploy
This project can be deployed in Kubernetes, but also provides binary files
and Docker images to make it easy to be deployed however wanted
### Binaries
Binary files for most popular platforms will be added to the [releases](https://github.com/freepik-company/bifrost/releases)
### Kubernetes
You can deploy `bifrost` in Kubernetes using Helm as follows:
```console
helm repo add bifrost https://freepik-company.github.io/bifrost/
helm upgrade --install --wait bifrost \
--namespace bifrost \
--create-namespace freepik-company/bifrost
```
> More information and Helm packages [here](https://freepik-company.github.io/bifrost/)
### Docker
Docker images can be found in GitHub's [packages](https://github.com/freepik-company/bifrost/pkgs/container/bifrost)
related to this repository
> Do you need it in a different container registry? I think this is not needed, but if I'm wrong, please, let's discuss
> it in the best place for that: an issue
## How to contribute
We are open to external collaborations for this project: improvements, bugfixes, whatever.
For doing it, open an issue to discuss the need of the changes, then:
- Fork the repository
- Make your changes to the code
- Open a PR and wait for review
The code will be reviewed and tested (always)
> We are developers and hate bad code. For that reason we ask you the highest quality
> on each line of code to improve this project on each iteration.
## License
Copyright 2022.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
[//]: #
[Config Example]: <./README.md#configuration>