putplace/ppserver.toml.example at main · jdrumgoole/putplace · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# PutPlace Server Configuration
# Copy this file to ppserver.toml and customize for your environment.
#
# User accounts, authentication, registration, password reset, OAuth, and
# auth-email sending are owned by the regstack library — see the notes near
# the bottom of this file, or the regstack docs:
# https://regstack.readthedocs.io. Putplace itself only owns the MongoDB /
# storage / API metadata sections below.

[database]
mongodb_url = "mongodb://localhost:27017"
mongodb_database = "putplace"
mongodb_collection = "file_metadata"

[api]
title = "PutPlace API"
description = "File metadata storage API"

[storage]
# Storage backend: "local" or "s3"
backend = "local"

# Local storage settings (used when backend = "local")
path = "./storage/files"

# S3 storage settings (used when backend = "s3")
# Uncomment and configure if using S3:
# s3_bucket_name = "your-bucket-name"
# s3_region_name = "us-east-1"
# s3_prefix = "files/"

[aws]
# AWS credentials (optional — will use AWS credential chain if not specified)
# Recommended: Use IAM roles or AWS CLI config instead of hardcoding credentials.
# profile = "your-aws-profile"
# access_key_id = "your-access-key"
# secret_access_key = "your-secret-key"

# =============================================================================
# regstack (auth + accounts)
# =============================================================================
#
# regstack reads its own settings from REGSTACK_* environment variables and/or
# an adjacent regstack.toml file — not from this file. The settings below are
# only documentation of which knobs exist; uncommenting them here has no effect.
#
# Required in production:
#   REGSTACK_JWT_SECRET=<64-byte random>
#     export REGSTACK_JWT_SECRET=$(python -c 'import secrets; print(secrets.token_urlsafe(64))')
#
# Optional:
#   REGSTACK_EMAIL__BACKEND=ses
#   REGSTACK_EMAIL__FROM_ADDRESS=noreply@example.com
#   REGSTACK_EMAIL__SES_REGION=eu-west-1
#   REGSTACK_OAUTH__GOOGLE_CLIENT_ID=<google-client-id>
#   REGSTACK_OAUTH__GOOGLE_CLIENT_SECRET=<google-client-secret>
#   REGSTACK_ALLOW_REGISTRATION=true
#
# Admin user (created by the putplace server on first startup if no users exist):
#   PUTPLACE_ADMIN_EMAIL=admin@example.com
#   PUTPLACE_ADMIN_PASSWORD=<8+ chars>
# If neither is set, a random password is generated and written once to
# /tmp/putplace_initial_creds.txt — save it and delete the file.

# =============================================================================
# Usage Notes
# =============================================================================
#
# 1. Copy this file to ppserver.toml:
#    cp ppserver.toml.example ppserver.toml
#
# 2. Edit ppserver.toml with your configuration.
#
# 3. Or use the configuration wizard:
#    pp_configure
#    (or: invoke configure)
#
# 4. Never commit ppserver.toml to version control (already in .gitignore).
#
# 5. Set restrictive file permissions:
#    chmod 600 ppserver.toml