Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
140 lines (117 loc) · 6.11 KB
/
Copy path.env.example
File metadata and controls
140 lines (117 loc) · 6.11 KB
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# Clone this file to `.env` and edit the clone.
NODE_ENV=development
# Companion
# =======================
COMPANION_DATADIR=./output
COMPANION_DOMAIN=localhost:3020
COMPANION_PROTOCOL=http
COMPANION_PORT=3020
COMPANION_CLIENT_ORIGINS=true
COMPANION_SECRET=development
COMPANION_PREAUTH_SECRET=development2
# NOTE: Only enable this in development. Enabling it in production is a security risk
COMPANION_ALLOW_LOCAL_URLS=true
COMPANION_ENABLE_URL_ENDPOINT=true
COMPANION_ENABLE_GOOGLE_PICKER_ENDPOINT=true
# to enable S3
COMPANION_AWS_KEY="YOUR AWS KEY"
COMPANION_AWS_SECRET="YOUR AWS SECRET"
# specifying a secret file will override a directly set secret
# COMPANION_AWS_SECRET_FILE="PATH/TO/AWS/SECRET/FILE"
COMPANION_AWS_BUCKET="YOUR AWS S3 BUCKET"
COMPANION_AWS_REGION="AWS REGION"
COMPANION_AWS_PREFIX="OPTIONAL PREFIX"
# to enable S3 Transfer Acceleration (default: false)
# COMPANION_AWS_USE_ACCELERATE_ENDPOINT="false"
# to enable S3 path style uploads (default: false), this is useful for localstack support
# COMPANION_AWS_FORCE_PATH_STYLE="true"
# to set X-Amz-Expires query param in presigned urls (in seconds, default: 800)
# COMPANION_AWS_EXPIRES="800"
# to set a canned ACL for uploaded objects: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
# COMPANION_AWS_ACL="public-read"
# to request server-side encryption for uploaded objects: AES256, aws:fsx, aws:kms or aws:kms:dsse
# COMPANION_AWS_SSE="aws:kms"
# to use a specific KMS key (optional, only used together with a KMS COMPANION_AWS_SSE)
# COMPANION_AWS_SSE_KMS_KEY_ID="arn:aws:kms:eu-west-2:123456789012:key/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# EXPERIMENTAL: the S3 provider's options, these variables and its /s3/* endpoints will change
# incompatibly, also in minor releases.
# The S3 *provider* (browsing and managing a bucket from the Dashboard via @uppy/s3) is configured
# separately from the uploads above, and stays disabled until it has either a bucket or a grant key.
# Anything left unset falls back to the COMPANION_AWS_* values above, so the provider can use its
# own account, endpoint and credentials. Restrict what those credentials may do with an IAM policy
# or a bucket policy: Companion does not police buckets, it only enforces the prefix in a grant.
# COMPANION_S3_PROVIDER_KEY="YOUR S3 KEY"
# COMPANION_S3_PROVIDER_SECRET="YOUR S3 SECRET"
# specifying a secret file will override a directly set secret
# COMPANION_S3_PROVIDER_SECRET_FILE="PATH/TO/S3/PROVIDER/SECRET/FILE"
# COMPANION_S3_PROVIDER_REGION="AWS REGION"
# COMPANION_S3_PROVIDER_ENDPOINT="https://s3.example.com"
# COMPANION_S3_PROVIDER_FORCE_PATH_STYLE="true"
# Single-tenant: everybody who can reach Companion browses this bucket (and only this prefix), so
# put Companion behind your own authentication.
# COMPANION_S3_PROVIDER_BUCKET="YOUR S3 BUCKET"
# COMPANION_S3_PROVIDER_PREFIX="uploads/"
# Multi-tenant: your server mints a short-lived storage grant per user after it authenticated them,
# naming the bucket, the prefix they may see and whether they may write. Set the secret it signs
# with (HS256), or better the public key of an asymmetric key pair, and Companion verifies grants
# without being able to mint them. Either may be a comma-separated list while you rotate keys.
# A grant key cannot be combined with COMPANION_S3_PROVIDER_BUCKET/_PREFIX (Companion refuses to start).
# COMPANION_S3_PROVIDER_GRANT_SECRET="A LONG RANDOM SECRET"
# COMPANION_S3_PROVIDER_GRANT_SECRET_FILE="PATH/TO/GRANT/SECRET/FILE"
# COMPANION_S3_PROVIDER_GRANT_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"
# Objects the provider writes itself (copies made by a move, folder markers):
# COMPANION_S3_PROVIDER_ACL="private"
# COMPANION_S3_PROVIDER_SSE="aws:kms"
# COMPANION_S3_PROVIDER_SSE_KMS_KEY_ID="arn:aws:kms:eu-west-2:123456789012:key/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
COMPANION_BOX_KEY=***
COMPANION_BOX_SECRET=***
COMPANION_DROPBOX_KEY=***
COMPANION_DROPBOX_SECRET=***
COMPANION_GOOGLE_KEY=***
COMPANION_GOOGLE_SECRET=***
COMPANION_FACEBOOK_KEY=***
COMPANION_FACEBOOK_SECRET=***
COMPANION_ZOOM_KEY=***
COMPANION_ZOOM_SECRET=***
COMPANION_UNSPLASH_KEY=***
COMPANION_UNSPLASH_SECRET=***
COMPANION_ONEDRIVE_KEY=***
COMPANION_ONEDRIVE_SECRET=****
# To test dynamic Oauth against local companion (which is pointless but allows us to test it without Transloadit's servers), enable these:
#COMPANION_GOOGLE_KEYS_ENDPOINT=http://localhost:3020/drive/test-dynamic-oauth-credentials?secret=development
#COMPANION_TEST_DYNAMIC_OAUTH_CREDENTIALS=true
#COMPANION_TEST_DYNAMIC_OAUTH_CREDENTIALS_SECRET=development
# Development environment
# =======================
VITE_UPLOADER=tus
# VITE_UPLOADER=s3
# VITE_UPLOADER=s3-multipart
# xhr will use protocol 'multipart' in companion, if used with a remote service, e.g. google drive.
# If local upload will use browser XHR
# VITE_UPLOADER=xhr
# VITE_UPLOADER=transloadit
# VITE_UPLOADER=transloadit-s3
# VITE_UPLOADER=transloadit-xhr
VITE_COMPANION_URL=http://localhost:3020
# See also Transloadit.COMPANION_PATTERN
VITE_COMPANION_ALLOWED_HOSTS="\.transloadit\.com$"
VITE_TUS_ENDPOINT=https://tusd.tusdemo.net/files/
VITE_XHR_ENDPOINT=https://xhr-server.herokuapp.com/upload
# If you want to test dynamic Oauth
# VITE_COMPANION_GOOGLE_DRIVE_KEYS_PARAMS_CREDENTIALS_NAME=companion-google-drive
VITE_TRANSLOADIT_KEY=***
VITE_TRANSLOADIT_TEMPLATE=***
VITE_TRANSLOADIT_SERVICE_URL=https://api2.transloadit.com
# Fill in if you want requests sent to Transloadit to be signed:
# VITE_TRANSLOADIT_SECRET=***
# For Google Photos Picker and Google Drive Picker:
VITE_GOOGLE_PICKER_CLIENT_ID=***
# For Google Drive Picker
VITE_GOOGLE_PICKER_API_KEY=***
VITE_GOOGLE_PICKER_APP_ID=***
# Transloadit Storage in the dev example: the workspace to browse (Companion must point its S3
# endpoint at api2's /storage), an optional SmartCDN-enabled key for Copy Smart CDN URL, and a
# local api2 URL Transform base (https://api2-devdock.transloadit.dev/file/<workspace>) instead of tlcdn.com.
# VITE_TRANSLOADIT_STORAGE_WORKSPACE="my-workspace"
# VITE_TRANSLOADIT_STORAGE_CDN_KEY="A SMARTCDN-ENABLED AUTH KEY"
# VITE_TRANSLOADIT_STORAGE_CDN_ENDPOINT="https://api2-devdock.transloadit.dev/file/my-workspace"