A simple proxy to browse files from private S3 buckets. Helpful to be put behind another authenticating web server, such as Apache or NGINX.
Go to file
Matteo Settenvini 4defbcec1f Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
.vscode Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
LICENSES Connect and retrieve initial bucket index 2023-07-01 13:37:21 +02:00
src Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
templates Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
tests Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
.gitignore Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
.pre-commit-config.yaml Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
CMakeLists.txt CVE: RUSTSEC-2018-0017: use tempfile instead of tempdir 2023-07-12 17:19:26 +02:00
Cargo.lock Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
Cargo.lock.license Connect and retrieve initial bucket index 2023-07-01 13:37:21 +02:00
Cargo.toml Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
README.md Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00
deny.toml Stabilize and update deps 2023-11-26 19:19:28 +01:00
serves3.toml.example Reimplement config parsing, add integration tests 2024-06-02 16:47:49 +02:00

README.md

[//]: # SPDX-FileCopyrightText: © Matteo Settenvini matteo.settenvini@montecristosoftware.eu [//]: # SPDX-License-Identifier: EUPL-1.2

serves3

A very simple proxy to browse files from private S3 buckets.

Helpful to be put behind another authenticating web server, such as Apache or NGINX.

Also helpful to do a different TLS termination.

Configuration

Copy serves3.toml.example to serves3.toml and adjust your settings.

You can also use the same file to customize the server options. See the Rocket documentation for a list of understood values.

Then just configure Apache or NGINX to proxy to the given port. For example:

<VirtualHost *:443>
    ServerName example.com
    ServerAdmin support@example.com
    DocumentRoot /var/www

    ProxyPreserveHost On
    ProxyPass /s3/ http://127.0.0.1:8000/
    ProxyPassReverse /s3/ http://127.0.0.1:8000/

    # ... other options ...
</VirtualHost>

You probably also want a systemd unit file, for instance /etc/systemd/system/serves3@.service:

[Unit]
Description=ServeS3, a S3 proxy
StartLimitInterval=100
StartLimitBurst=10

[Service]
Type=simple
ExecStart=/usr/local/bin/serves3
WorkingDirectory=/etc/serves3/%i/
Environment=ROCKET_PORT=%i

Restart=always
RestartSec=5s

[Install]
WantedBy=multi-user.target

Then, e.g. for running on port 8000, you would put the corresponding configuration file in /etc/serves3/8000/ and install the unit with systemctl enable --now serves3@8000.service.

Build and install

If you want more granular control on installation options, use CMake:

cmake -B build .
cmake --build build
cmake --install build
cd run-folder # folder with Settings.toml
serves3

Else you can simply rely on cargo:

cargo install --root /usr/local --path . # for instance
cd run-folder # folder with Settings.toml
serves3

Changelog

1.1.0 Reworked configuration file logic

  • Breaking change: configuration file renamed to serves3.toml. Please note that the format changed slightly; have a look at the provided serves3.toml.example file for reference.

1.0.0

  • Initial release.