ctfer-io/CTFd-Setup
Setup a CTFd from a versionned configuration file.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| file | Configuration file to use for setting up CTFd. If let empty, will default the values and look for secrets in expected environment variables. For more info, refers to the documentation. | — | — |
| dir | The directory to parse from. | — | — |
| url | URL to reach the CTFd instance. | yes | — |
| api_key | The API key to use (for instance for a CI SA), used for updating a running CTFd instance. | — | — |
| appearance_name | The name of your CTF, displayed as is. | — | — |
| appearance_description | The description of your CTF, displayed as is. | — | — |
| theme_logo | The frontend logo. Provide a path to a locally-accessible file. | — | — |
| theme_small_icon | The frontend small icon. Provide a path to a locally-accessible file. | — | — |
| theme_name | The frontend theme name. | — | core |
| theme_color | The frontend theme color. | — | — |
| theme_header | The frontend header. Provide a path to a locally-accessible file. | — | — |
| theme_footer | The frontend footer. Provide a path to a locally-accessible file. | — | — |
| theme_settings | The frontend settings (JSON). Provide a path to a locally-accessible file. | — | — |
| accounts_domain_whitelist | The domain whitelist (a list separated by colons) to allow users to have email addresses from. | — | — |
| accounts_domain_blacklist | The domain blacklist (a list separated by colons) to block users to have email addresses from. | — | — |
| accounts_verify_emails | Whether to verify emails once a user register or not. | — | false |
| accounts_team_creation | Whether to allow team creation by players or not. | — | — |
| accounts_team_size | Maximum size (number of players) in a team. | — | — |
| accounts_password_min_length | Minimal length of password. | — | — |
| accounts_num_teams | The total number of teams allowed. | — | — |
| accounts_num_users | The total number of users allowed. | — | — |
| accounts_team_disbanding | Whether to allow teams to be disbanded or not. Could be inactive_only or disabled. | — | — |
| accounts_incorrect_submissions_per_minute | Maximum number of invalid submissions per minute (per user/team). We suggest you use it as part of an anti-brute-force strategy (rate limiting). | — | — |
| accounts_name_changes | Whether a user can change its name or not. | — | — |
| challenges_view_self_submissions | Whether a player can see itw own previous submissions. | — | — |
| challenges_max_attempts_behavior | The behavior to adopt in case a player reached the submission rate limiting. | — | lockout |
| challenges_max_attempts_timeout | The duration of the submission rate limit for further submissions. | — | — |
| challenges_hints_free_public_access | Control whether users must be logged in to see free hints. | — | — |
| challenges_challenge_ratings | Who can see and submit challenge ratings. | — | public |
| pages_robots_txt | Define the /robots.txt file content, for web crawlers indexing. | — | — |
| major_league_cyber_client_id | The MajorLeagueCyber OAuth ClientID. | — | — |
| major_league_cyber_client_secret | The MajorLeagueCyber OAuth Client Secret. | — | — |
| settings_challenge_visibility | The visibility for the challenges. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/). | — | public |
| settings_account_visibility | The visibility for the accounts. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/). | — | public |
| settings_score_visibility | The visibility for the scoreboard. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/). | — | public |
| settings_registration_visibility | The visibility for the registration. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/). | — | public |
| settings_paused | Whether the CTFd is paused or not. | — | — |
| security_html_sanitization | Whether to turn on HTML sanitization or not. | — | — |
| security_registration_code | The registration code (secret) to join the CTF. | — | — |
| email_registration_subject | The email registration subject of the mail. | — | — |
| email_registration_body | The email registration body of the mail. | — | — |
| email_confirmation_subject | The email confirmation subject of the mail. | — | — |
| email_confirmation_body | The email confirmation body of the mail. | — | — |
| email_new_account_subject | The email new_account subject of the mail. | — | — |
| email_new_account_body | The email new_account body of the mail. | — | — |
| email_password_reset_subject | The email password_reset subject of the mail. | — | — |
| email_password_reset_body | The email password_reset body of the mail. | — | — |
| email_password_reset_confirmation_subject | The email password_reset_confirmation subject of the mail. | — | — |
| email_password_reset_confirmation_body | The email password_reset_confirmation body of the mail. | — | — |
| email_from | The 'From:' to sent to mail with. | — | — |
| email_server | The mail server to use. | — | — |
| email_port | The mail server port to reach. | — | — |
| email_username | The username to log in to the mail server. | — | — |
| email_password | The password to log in to the mail server. | — | — |
| email_tls_ssl | Whether to turn on TLS/SSL or not. | — | — |
| email_starttls | Whether to turn on STARTTLS or not. | — | — |
| time_start | The start timestamp at which the CTFd will open. | — | — |
| time_end | The end timestamp at which the CTFd will close. | — | — |
| time_freeze | The freeze timestamp at which the CTFd will remain open but won't accept any further submissions. | — | — |
| time_view_after | Whether allows users to view challenges after end or not. | — | — |
| social_shares | Whether to enable users share they solved a challenge or not. | — | — |
| social_template | A template for social shares. Provide a path to a locally-accessible file. | — | — |
| legal_tos_url | The Terms of Services URL. | — | — |
| legal_tos_content | The Terms of Services content | — | — |
| legal_privacy_policy_url | The Privacy Policy URL. | — | — |
| legal_privacy_policy_content | The Privacy Policy content. | — | — |
| mode | The mode of your CTFd, either users or teams. | — | users |
| admin_name | The administrator name. | — | — |
| admin_email | The administrator email address. | — | — |
| admin_password | The administrator password. | — | — |
Outputs
no outputs