This repository has been archived by the owner on Feb 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
dotenv.example
165 lines (141 loc) · 6.63 KB
/
dotenv.example
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# IF you are trying to run this code on a LAMP-stack-equipped machine,
# copy this file to .env (with the dot!) and then edit it to change
# your settings.
#
# NOTE: Any edits you make to this file, or to an .env file which you
# copied from this, won't appear in production. The deployment scripts
# know nothing about this file. You need to edit the
# ansible/secrets.yml file, and/or the template at
# ansible/roles/site-deployed/templates/dotenv.j2.
#
# NOTE: If you are running Vagrant, ignore this file completely. Edit
# the Vagrant-generated .env file, or the Ansible files mentioned in
# the previous paragraph, instead.
### Temporary directories; all must be Apache-writable.
PTRON_TMPDIR="tmp"
# Used for sessions. Default location is bad because all PHP
# scripts running on the same server will clean up sessions
# with the default session lifetimes, rather than the one
# specified below.
#
# Also used for KRB5CCNAME when managing moira lists.
PTRON_SESSION_CACHE_DIR="tmp"
# Path for cached HTMLPurifier data
PTRON_HTMLPURIFIER_CACHE_PATH="tmp/purifier-cache"
### Paths for local file storage
# Path for user pictures; must be Apache-writable
#
# The PTRON_PICPATH needs some fixing; it currently serves as:
# - part of the path for local picture files
# - part of the URL for picture downloads
# - part of the object name and URL for Amazon S3 uploads of pictures
PTRON_PICPATH="uploads/pictures/"
# MySQL database connection information
PTRON_DB_NAME="puzzletron"
PTRON_DB_USER="puzzletron"
PTRON_DB_PASSWORD="changeMeToARandomString"
PTRON_DB_SERVER="localhost"
# AWS connection information
PTRON_AWS_ACCESS_KEY_ID="someAWSAssignedRandomString"
PTRON_AWS_SECRET_ACCESS_KEY="someMuchLongerAWSAssignedRandomString"
PTRON_AWS_BUCKET="aBucketNameToStoreYourPuzzletronFiles"
PTRON_AWS_ENDPOINT="https://s3.amazonaws.com/"
### urls and email addresses for your team
# Who emails come from
PTRON_FROM_EMAIL="[email protected]"
# Top-level URL of this site as deployed; used in all kinds of links and redirects.
PTRON_URL="https://example.org"
# Top-level URL of the postproduction site, used to generate links to puzzles in postprod.
PTRON_POSTPROD_URLPREFIX="https://xxxmysteryhunt.com/"
# An alternative postprod URL. There's some duct-tape hackery in
# puzzle.php which decides which gets used.
PTRON_POSTPROD_BETA_URLPREFIX="https://xxxmysteryhunt.com/"
# This appears in one link on the site admin page.
PTRON_PHPMYADMIN_URL="https://scripts.mit.edu/~sql/phpMyAdmin/"
# Error pages and the like ask the unhappy user to email this address:
PTRON_HELP_EMAIL="[email protected]"
# This appears as the target of the Wiki link in the navbar. If it's
# an empty string, that nav element is hidden
PTRON_WIKI_URL="https://sites.google.com/site/blahblahblah"
# This is used as the prefix URL for the testsolving wiki, if you have
# one. If it's blank, on testsolve wiki URL is generated.
PTRON_TESTSOLVE_WIKI="https://some.mediawiki.install/wiki"
# This appears at the bottom of the homepage.
PTRON_BUGTRACK_URL="https://github.com/mysteryhunt/puzzle-editing/issues"
# When submitting new puzzles, authors will have to agree to license
# their puzzles for redistribution. This specifies who they license
# them to
PTRON_LICENSEE_NAME="Alyssa P. Hacker"
# Define these to use Mailgun for outgoing email.
PTRON_MAILGUN_API_URL="https://api.mailgun.net/v2/your.mail.domain.here.example.com"
PTRON_MAILGUN_API_KEY="key-3141592etcetc"
# If this is set, Puzzletron will send a Slack webhook for certain
# events worthy of team celebration
PTRON_SLACK_WEBHOOK_URL="https://yourorg.slack.com/services/etc"
# Use internal puzzletron authentication.
# This is if you're behind an SSO system / apache proxy that does auth.
#
# PTRON_TRUST_REMOTE_USER disables the internal puzzletron user database
# and trusts the apache `REMOTE_USER` variable (only do this if you
# have apache auth set up and a separate authentication database)
# (warning: Random Fish doesn't have this turned on and doesn't know
# if our changes have broken Puzzletron if it does get turned on)
#
# (The odds of this broken feature going away are high.)
PTRON_TRUST_REMOTE_USER="FALSE"
# Used in conjunction with ALLOW_EDITOR_PICK. If set to a negative
# number, don't display editor counts
PTRON_MIN_EDITORS="2"
# Used in conjunction with ALLOW_EDITOR_PICK and USING_APPROVERS
PTRON_MIN_APPROVERS="2"
# If a puzzle has this many approvals, then it's eligible to be
# advanced to the next state
PTRON_APROVALS_REQUIRED="2"
# If set to a non-0 value, puzzletron will send a reminder email
# asking for updates to puzzles that seem to have been blocked on
# authors for this many days
PTRON_REMINDER_EMAIL_DAYS="0"
# date of the next hunt - used to run the countdown on the home page
PTRON_HUNT_YEAR="2017"
# DOM = "Day of Month" - that month is January, of course
PTRON_HUNT_DOM="13"
### Feature flags
# These two settings do nothing but change the site title display and the subject
# lines of outgoing emails.
PTRON_DEVMODE="TRUE"
PTRON_PRACMODE="TRUE"
# Display list of puzzles for testsolvers to pick from
PTRON_ALLOW_TESTSOLVE_PICK="TRUE"
# Display list of puzzles for editors to pick from
PTRON_ALLOW_EDITOR_PICK="TRUE"
PTRON_USING_TESTSOLVE_REQUESTS="FALSE"
PTRON_USING_TESTSOLVE_TEAMS="FALSE"
PTRON_USING_ROUND_CAPTAINS="FALSE"
PTRON_USING_APPROVERS="FALSE"
PTRON_USING_CREDITS="FALSE"
# USING_AWS affects:
# html.php line 151: link to author thumbnails from the thumbs bucket in S3
# puzzle.php line 979: link to filelists in S3
# puzzle.php line 1188: YOLO substitution of S3 bucket URL for upload URL in comment bodies?
# test.php line 123: link to drafts from s3 bucket
# utils-pic.php: move uploaded pics and thumbs into S3
# utils.php: copies uploaded file attachments (like drafts) to S3
PTRON_USING_AWS="FALSE"
PTRON_ANON_TESTERS="FALSE"
# This feature does not appear to be working at the moment; codenames are never written?
PTRON_USING_CODENAMES="FALSE"
# If enabled, uploaded zip files will be unzipped on the server, allowing users to access
# individual files within those zip files without having to download the entire zip file.
PTRON_UNZIP_ZIP_UPLOADS="TRUE"
# If enabled, then a different limit for the maximum number of testers
# can be configured for each puzzle.
PTRON_USING_PER_PUZZLE_TESTER_LIMITS="FALSE"
# Used in conjunction with USING_PER_PUZZLE_TESTER_LIMITS. If
# per-puzzle limits are enabled, this sets the default limit.
PTRON_DEFAULT_PER_PUZZLE_TESTER_LIMIT="3"
### MIT-specific mailing list features; not tested for at least a year.
PTRON_MAILING_LISTS="FALSE"
PTRON_GET_KEYTAB="kinit -k -t KEYTAB_FILE PRINCIPAL"
PTRON_MMBLANCHE_CMD="athrun consult mmblanche"
PTRON_MMBLANCHE_PASSWORDS="PASSWORD_DIR"
PTRON_EDITOR_MAILING_LIST="EDITOR_LIST"