You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
_Also see [app.json](https://github.com/codeRIT/hackathon_manager/blob/master/app.json)_
26
-
27
-
### Secret keys
28
-
29
-
`SECRET_KEY_BASE` and `DEVISE_SECRET_KEY` are required for the app to run. You can generate secrets via `bundle exec rake secret`. This "secret" is a 64-byte hexadecimal string (128 characters). You could also generate this with `head -c 64 /dev/urandom | xxd -ps -c 128` if you are on a standard Linux distribution.
20
+
You can generate secrets via `bundle exec rake secret`. This "secret" is a 64-byte hexadecimal string (128 characters). You could also generate this with `head -c 64 /dev/urandom | xxd -ps -c 128` if you are on a standard Linux distribution.
30
21
31
22
### Mailer domain
32
23
@@ -35,9 +26,9 @@ HM_DOMAIN_NAME=""
35
26
HM_DOMAIN_PROTOCOL=""# optional, https by default
36
27
```
37
28
38
-
### Resumes and S3
29
+
This is needed to allow HackathonManager to send email on behalf of your hackathon's domain.
39
30
40
-
Resumes are stored locally in development and on S3 in production.
31
+
### Amazon S3 and Resumes
41
32
42
33
```bash
43
34
AWS_BUCKET=""
@@ -46,6 +37,9 @@ AWS_SECRET_ACCESS_KEY=""
46
37
AWS_REGION=""
47
38
```
48
39
40
+
Resumes for hackers are stored on [Amazon S3](https://aws.amazon.com/s3/).
41
+
42
+
### Other providers
49
43
If you're using a third-party S3 provider, such as [Minio](https://min.io), also specify the custom endpoint.
50
44
51
45
```bash
@@ -64,17 +58,17 @@ Emails can be sent using [SendGrid](https://sendgrid.com) or traditional SMTP.
64
58
65
59
#### SendGrid
66
60
61
+
```bash
62
+
SENDGRID_API_KEY=""
63
+
```
64
+
67
65
[SendGrid](https://sendgrid.com) is the recommended email provider, and provides a free plan suitable for most hackathons.
68
66
69
67
Create a SendGrid API key to get started. During the setup process you will be asked to authenticate your sending domain with SendGrid. For guidance on this process please visit [SendGrid Domain Authentication Support](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/). If you would like to maintain your sending reputation and stay out of the spam folder, we reccomend enabling [SendGrid Link Branding](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-link-branding/) when asked during the setup process.
70
68
71
69
72
70
>During the verification process ensure you have replaced `hello@example.com` with your own domain in your HackathonManager config. SendGrid will deny the email as you are not authenticated to send on behalf of `example.com`.
73
71
74
-
```bash
75
-
SENDGRID_API_KEY=""
76
-
```
77
-
78
72
#### SMTP
79
73
80
74
>Sending email with SMTP over a personal or school email address (such as Gmail) is **NOT** recommended. Your hackathon may easily send several hundred to a few thousand emails during months leading up to the event, which regular email accounts block and may get reported for spam.
@@ -90,37 +84,43 @@ SMTP_AUTHENTICATION="" # optional, "plain" by default
90
84
SMTP_STARTTLS_AUTO=""# optional, "true" by default
91
85
```
92
86
93
-
### Rollbar
87
+
### Time Zone
94
88
95
-
Rollbar captures and notifies of errors in production, and requires a server-side access token.
89
+
>HackathonManager will crash at startup if the time zone isn't valid.
90
+
>
91
+
>To find your appropriate time zone (e.g. `America/New_York`), see "TZ database name" on [Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
96
92
97
93
```bash
98
-
ROLLBAR_ACCESS_TOKEN=""
94
+
TIME_ZONE="America/Los_Angeles"
99
95
```
100
96
101
-
### My MLH
97
+
By default, charts & timestamps will be in UTC.
98
+
99
+
## Optional
100
+
**The following environment variables are optional but add additional functionality.**
102
101
103
-
My MLH provides us authentication & initial application information.
102
+
### MyMLH
103
+
104
+
```bash
105
+
MLH_KEY=""
106
+
MLH_SECRET=""
107
+
```
108
+
109
+
[MyMLH](https://my.mlh.io/) makes it easy for hackers to quickly onboard themselves into HackathonManager. With MyMLH, hackers can save time by skipping fields in the questionnaire where the answer is already provided on their MyMLH profiles.
104
110
105
111
1. Create an account at https://my.mlh.io
106
112
2. Click "My Apps" in the top navbar
107
113
3. Click "Create new app"
108
114
4. Fill out the app name & logo
109
115
5. For "Redirect URI", fill in https://apply.your-hackathon.com/users/auth/mlh/callback
110
116
117
+
### Rollbar
118
+
111
119
```bash
112
-
MLH_KEY=""
113
-
MLH_SECRET=""
120
+
ROLLBAR_ACCESS_TOKEN=""
114
121
```
115
122
116
-
### Time Zone
123
+
[Rollbar](https://rollbar.com/) captures and notifies of errors in production, and requires a server-side access token.
117
124
118
-
By default, charts & timestamps will be in UTC.
119
125
120
-
>HackathonManager will crash at startup if the time zone isn't valid.
121
-
>
122
-
>To find your appropriate time zone (e.g. `America/New_York`), see "TZ database name" on [Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
0 commit comments