Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A sample staticman.yml for GitLab
# Name of the property. You can have multiple properties with completely
# different config blocks for different sections of your site.
# For example, you can have one property to handle comment submission and
# another one to handle posts.
comments:
# (*) REQUIRED
#
# Names of the fields the form is allowed to submit. If a field that is
# not here is part of the request, an error will be thrown.
allowedFields: ["comment", "name", "email", "website", "slug"]
auth:
required: false
# (*) REQUIRED
#
# Name of the branch being used. Must match the one sent in the URL of the
# request.
branch: "master"
# Text to use as the commit message or pull request title. Accepts placeholders.
commitMessage: "Add Staticman data"
# (*) REQUIRED
#
# Destination path (filename) for the data files. Accepts placeholders.
filename: "{options.slug}_{@timestamp}"
# The format of the generated data files. Accepted values are "json", "yaml"
# or "frontmatter"
format: "yaml"
# List of fields to be populated automatically by Staticman and included in
# the data file. Keys are the name of the field. The value can be an object
# with a `type` property, which configures the generated field, or any value
# to be used directly (e.g. a string, number or array)
generatedFields:
authType:
type: user
options:
property: "type"
email:
type: user
options:
property: "email"
username:
type: user
options:
property: "username"
name:
type: user
options:
property: "name"
siteUrl:
type: user
options:
property: "siteUrl"
date:
type: date
options:
format: "timestamp"
gitlabAuth:
clientId: your client id
clientSecret: your secret
redirectUri: http://localhost:8000/
# Whether entries need to be appproved before they are published to the main
# branch. If set to `true`, a pull request will be created for your approval.
# Otherwise, entries will be published to the main branch automatically.
moderation: false
# Name of the site. Used in notification emails.
name: "team-parallax.com"
# Notification settings. When enabled, users can choose to receive notifications
# via email when someone adds a reply or a new comment. This requires an account
# with Mailgun, which you can get for free at http://mailgun.com.
#notifications:
# Enable notifications
#enabled: true
# (!) ENCRYPTED
#
# Mailgun API key
#apiKey: "1q2w3e4r"
# (!) ENCRYPTED
#
# Mailgun domain (encrypted)
#domain: "4r3e2w1q"
# (*) REQUIRED
#
# Destination path (directory) for the data files. Accepts placeholders.
path: "data/comments"
# Names of required fields. If any of these isn't in the request or is empty,
# an error will be thrown.
requiredFields: ["name", "comment", "email", "slug"]
# List of transformations to apply to any of the fields supplied. Keys are
# the name of the field and values are possible transformation types.
transforms:
email: md5
reCaptcha:
enabled: false
siteKey: ""
secret: ""
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment