aboutsummaryrefslogtreecommitdiffstats
path: root/community/garage/garage.toml
diff options
context:
space:
mode:
Diffstat (limited to 'community/garage/garage.toml')
-rw-r--r--community/garage/garage.toml99
1 files changed, 99 insertions, 0 deletions
diff --git a/community/garage/garage.toml b/community/garage/garage.toml
new file mode 100644
index 00000000000..a7ee4c0f756
--- /dev/null
+++ b/community/garage/garage.toml
@@ -0,0 +1,99 @@
+# See https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/
+# for a complete documentation of the available options.
+
+# Hint: If you want to initialize a Garage cluster with just a single node, run:
+#
+# $ node_id=$(garage node id -q | cut -d@ -f1)
+# $ garage layout assign -c1 -z garage $node_id
+# $ garage layout apply --version 1
+#
+
+# The directory in which Garage will store its metadata.
+metadata_dir = "/var/lib/garage/meta"
+
+# The directory in which Garage will store the data blocks of objects.
+data_dir = "/var/lib/garage/data"
+
+# Whether to enable synchronous mode for the database engine or not.
+#metadata_fsync = false
+
+# Whether to fsync data blocks and their containing directory after they are
+# saved to disk.
+#data_fsync = false
+
+# Garage is only built with "lmdb" on Alpine Linux since v3.19! If you're still
+# using "sled", migrate it using 'garage-convert-db' package from Alpine v3.18.
+#db_engine = "lmdb"
+
+# The block size for stored objects.
+#block_size = 1048576
+
+# The map size used by LMDB, which is the size of the virtual memory region
+# used for mapping the database file. It's not bound by the physical RAM size
+# of the machine running Garage.
+#lmdb_map_size = "1T"
+
+# Refer to the reference manual.
+replication_mode = "none"
+
+# Zstd compression level to use for storing blocks. Defaults to 1.
+compression_level = 1
+
+# The address and port on which to bind for inter-cluster communications.
+# Hint: Change to 127.0.0.1:3901 if running a single node cluster.
+rpc_bind_addr = "[::]:3901"
+
+# The address and port that other nodes need to use to contact this node for
+# RPC calls.
+# rpc_public_addr = "127.0.0.1:3901"
+
+# The secret key that is shared between all nodes of the cluster in order to
+# identify these nodes and allow them to communicate together. This key should
+# be specified here in the form of a 32-byte hex-encoded random string.
+# NOTE: The init script will automatically replace "change-me" value with
+# a random string on the service start.
+rpc_secret = "change-me"
+# or read it from the file.
+#rpc_secret_file = ""
+
+# A list of peer identifiers on which to contact other Garage peers of this
+# cluster. Format: <node public key>@<node public IP or hostname>:<port>.
+#bootstrap_peers = []
+
+[s3_api]
+# The IP and port on which to bind for accepting S3 API calls. This endpoint
+# doesn't support TLS: a reverse proxy (e.g. nginx) should be used to provide it.
+api_bind_addr = "[::]:3900"
+
+# The region name.
+s3_region = "garage"
+
+# The optional suffix to access bucket using vhost-style in addition to
+# path-style request.
+root_domain = ""
+
+[s3_web]
+# The IP and port on which to bind for accepting HTTP requests to buckets
+# configured for website access. This endpoint doesn't support TLS: a reverse
+# proxy (e.g. nginx) should be used to provide it.
+bind_addr = "127.0.0.1:3902"
+
+# The optional suffix appended to bucket names for the corresponding HTTP Host.
+root_domain = ""
+
+[admin]
+# If specified, Garage will bind an HTTP server to this port and address,
+# on which it will listen to requests for administration features.
+#api_bind_addr = ""
+
+# The token for accessing all of the other administration endpoints.
+# If not set, access to these endpoints is disabled entirely.
+#admin_token = ""
+# or read it from the file.
+#admin_token_file = ""
+
+# The token for accessing the Metrics endpoint. If not set, the Metrics
+# endpoint can be accessed without access control!
+#metrics_token = ""
+# or read it from the file.
+#metrics_token_file = ""