Portainer Templates logo

Portainer Templates

Scality S3 Scality S3

Container

Storage

Standalone AWS S3 protocol server

Image details

Pulls: 6.5M
Architecture: amd64
Image size: 311 MB
Latest: 2.1
User: scality
Created: Jun 01, 2016
Updated: 8 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
scality/s3server
Ports
8000/tcp
Volumes
/usr/src/app/localData/usr/src/app/localMetadata
Env vars
SCALITY_ACCESS_KEY=''SCALITY_SECRET_KEY=''

Template by portainer

Standalone Install

Select an install method, to see config/commands for deploying Scality S3

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Scality S3, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

S3Server is being renamed Cloud Server and part of Scality Zenko, Scality’s Open Source Multi-Cloud Data Controller. Learn more about Zenko at Zenko.io
You can find Cloud Server image here. If you have any questions please ask on Zenko Forum.

Supported tags and respective ``Dockerfile`` links

Running S3 Server with a file backend
Run S3 Server with an in-memory backend

Quick reference

- Where to get help: Open an issue on Github, Check our website, or just our documentation
- Where to file issues: Our Github repo
- Maintained by: Open-source community and Scality permanent staff
- Published image artifact details: Coming soon!
- Source of this description: Coming soon!
- Supported Docker versions: The latest release, and we run from 1.10

Quick start

The default access key is ``accessKey1`, with the secret key `verySecretKey1``
Run s3 server with a file backend on port 8000:
$ docker run -d --name s3server -p 8000:8000 scality/s3server
Run s3 server with an in-memory backend on port 8000:
$ docker run -d --name s3server -p 8000:8000 scality/s3server:mem-latest

Note that the --name selected (in the example 's3server') will enable you to easily start and stop the given named container:
$ docker stop s3server
$ docker start s3server

Continuous integration testing || in production usage

Using S3 for continuous integration testing or in production with Docker

Data storage

When using s3server with a file backend, all data is stored inside the container and is persisted between restarts. You can define the path for data and metadata storage, check our documentation on configuring storage path. When using s3sever with an in-memory backend, all data is lost after you stop the container.

Learn more by reading our documentation or checking out our website!

Serve Scality S3 on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying scality-s3.example.com to http://scality-s3:8000

Add this to your Caddyfile

scality-s3.example.com {
	reverse_proxy http://scality-s3:8000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 8000/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

Image won't pull

Test the pull directly on the host: docker pull scality/s3server

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Required settings are blank

SCALITY_ACCESS_KEY, SCALITY_SECRET_KEY have no default value, and the app may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Scality S3 runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Scality S3 needs bundled into one download. This template pulls scality/s3server, which Docker fetches once (about 311 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Scality S3's comes from Docker Hub, published by scality.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 2.1. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, so it runs on regular x86 PCs and servers, though not ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 8000, published on a random host port

Volumes

A volume is where Scality S3 keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /usr/src/app/localData as a volume Docker manages for you
  • /usr/src/app/localMetadata as a volume Docker manages for you

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Scality S3 takes 2 of them, and 2 need a value before it'll start properly:

  • SCALITY_ACCESS_KEY, needs a value. Scality S3 access key
  • SCALITY_SECRET_KEY, needs a value. Scality S3 secret key

Networking

Nothing custom is set, so Scality S3 sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Scality S3 up. Add the template list to Portainer once, then deploying Scality S3 is a click rather than a wall of config.