Blame files/pagure.cfg.sample

Pierre-Yves Chibon e91bef
import os
Pierre-Yves Chibon f31b10
from datetime import timedelta
Pierre-Yves Chibon 9a6466
Pierre-Yves Chibon 771fcc
### Set the time after which the admin session expires
Pierre-Yves Chibon 771fcc
# There are two sessions on pagure, login that holds for 31 days and
Pierre-Yves Chibon 771fcc
# the session defined here after which an user has to re-login.
Pierre-Yves Chibon 771fcc
# This session is used when accessing all administrative parts of pagure
Pierre-Yves Chibon 771fcc
# (ie: changing a project's or a user's settings)
Pierre-Yves Chibon 771fcc
ADMIN_SESSION_LIFETIME = timedelta(minutes=20)
Pierre-Yves Chibon 771fcc
Slavek Kabrda adea20
# Enable tickets and docs for all repos
Slavek Kabrda adea20
ENABLE_TICKETS = True
Slavek Kabrda adea20
ENABLE_DOCS = True
Slavek Kabrda adea20
Neal Gompa 3c09f6
# Enables / Disables private projects
Neal Gompa 3c09f6
PRIVATE_PROJECTS = True
Neal Gompa 3c09f6
Pierre-Yves Chibon 9a6466
### Secret key for the Flask application
Pierre-Yves Chibon 9a6466
SECRET_KEY='<the application="" key="" secret="" web="">'</the>
Pierre-Yves Chibon 9a6466
Pierre-Yves Chibon 9a6466
### url to the database server:
Neal Gompa 912c4d
#DB_URL = 'mysql://user:pass@host/db_name'
Neal Gompa 912c4d
#DB_URL = 'postgres://user:pass@host/db_name'
Pierre-Yves Chibon fe5017
DB_URL = 'sqlite:////var/tmp/pagure_dev.sqlite'
Pierre-Yves Chibon 9a6466
Neal Gompa f3525c
### Send FedMsg notifications of events in pagure
Neal Gompa f3525c
FEDMSG_NOTIFICATIONS = False
Neal Gompa f3525c
Pierre-Yves Chibon fe5017
### The FAS group in which the admin of pagure are
Pierre-Yves Chibon 771fcc
ADMIN_GROUP = ['sysadmin-main']
Pierre-Yves Chibon 9a6466
Pierre-Yves Chibon 1abf96
### Hard-coded list of global admins
Pierre-Yves Chibon 1abf96
PAGURE_ADMIN_USERS = []
Pierre-Yves Chibon 1abf96
Pierre-Yves Chibon 9a6466
### The email address to which the flask.log will send the errors (tracebacks)
Neal Gompa 9c34c4
EMAIL_ERROR = 'root@localhost'
Pierre-Yves Chibon 9a6466
Vivek Anand 2bb937
### SMTP settings
Pierre-Yves Chibon 771fcc
SMTP_SERVER = 'localhost'
Vyacheslav Anzhiganov 3f9d9d
SMTP_PORT = 25
Vyacheslav Anzhiganov 3f9d9d
SMTP_SSL = False
Vivek Anand 2bb937
Vivek Anand 2bb937
#Specify both for enabling SMTP with auth
Vyacheslav Anzhiganov 3f9d9d
SMTP_USERNAME = None
Vyacheslav Anzhiganov 3f9d9d
SMTP_PASSWORD = None
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 3bcdaf
### Information used to sent notifications
Neal Gompa 9c34c4
FROM_EMAIL = 'pagure@localhost.localdomain'
Neal Gompa 9c34c4
DOMAIN_EMAIL_NOTIFICATIONS = 'localhost.localdomain'
Pierre-Yves Chibon 3bcdaf
SALT_EMAIL = '<secret be="" changed="" key="" to="">'</secret>
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 9a6466
### The URL at which the project is available.
Neal Gompa 9c34c4
APP_URL = 'http://localhost.localdomain/'
Pierre-Yves Chibon 84571a
### The URL at which the documentation of projects will be available
Pierre-Yves Chibon 84571a
## This should be in a different domain to avoid XSS issues since we want
Pierre-Yves Chibon ce5b28
## to allow raw html to be displayed (different domain, ie not a sub-domain).
Neal Gompa 9c34c4
DOC_APP_URL = 'http://docs.localhost.localdomain'
Pierre-Yves Chibon e4b805
Pierre-Yves Chibon e4b805
### The URL to use to clone git repositories.
Neal Gompa 9c34c4
GIT_URL_SSH = 'ssh://git@localhost.localdomain/'
Neal Gompa 9c34c4
GIT_URL_GIT = 'git://localhost.localdomain/'
Pierre-Yves Chibon 9a6466
Pierre-Yves Chibon 9a6466
### Folder containing to the git repos
Pierre-Yves Chibon 9a6466
GIT_FOLDER = os.path.join(
Pierre-Yves Chibon 9a6466
    os.path.abspath(os.path.dirname(__file__)),
Pierre-Yves Chibon 9a6466
    '..',
Pierre-Yves Chibon 9a6466
    'repos'
Pierre-Yves Chibon 9a6466
)
Pierre-Yves Chibon 9a6466
Pierre-Yves Chibon cac3b5
### Folder containing the clones for the remote pull-requests
Pierre-Yves Chibon cac3b5
REMOTE_GIT_FOLDER = os.path.join(
Pierre-Yves Chibon cac3b5
    os.path.abspath(os.path.dirname(__file__)),
Pierre-Yves Chibon cac3b5
    '..',
Pierre-Yves Chibon cac3b5
    'remotes'
Pierre-Yves Chibon cac3b5
)
Pierre-Yves Chibon cac3b5
Patrick Uiterwijk 78afb3
### Whether to enable scanning for viruses in attachments
Patrick Uiterwijk 78afb3
VIRUS_SCAN_ATTACHMENTS = False
Patrick Uiterwijk 78afb3
Pierre-Yves Chibon cac3b5
Pierre-Yves Chibon 9a6466
### Configuration file for gitolite
Pierre-Yves Chibon 9a6466
GITOLITE_CONFIG = os.path.join(
Pierre-Yves Chibon 9a6466
    os.path.abspath(os.path.dirname(__file__)),
Pierre-Yves Chibon 9a6466
    '..',
Pierre-Yves Chibon 9a6466
    'gitolite.conf'
Pierre-Yves Chibon 9a6466
)
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 156357
### Home folder of the gitolite user
Pierre-Yves Chibon 156357
### Folder where to run gl-compile-conf from
Pierre-Yves Chibon 156357
GITOLITE_HOME = None
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 66faf5
### Version of gitolite used: 2 or 3?
Pierre-Yves Chibon d0272c
GITOLITE_VERSION = 3
Pierre-Yves Chibon 66faf5
Pierre-Yves Chibon 156357
### Folder containing all the public ssh keys for gitolite
Pierre-Yves Chibon 156357
GITOLITE_KEYDIR = None
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 156357
### Path to the gitolite.rc file
Pierre-Yves Chibon 156357
GL_RC = None
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 156357
### Path to the /bin directory where the gitolite tools can be found
Pierre-Yves Chibon 156357
GL_BINDIR = None
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 3adf88
# SSH Information
Pierre-Yves Chibon 3adf88
Pierre-Yves Chibon 3adf88
### The ssh certificates of the git server to be provided to the user
Pierre-Yves Chibon 3adf88
### /!\ format is important
Pierre-Yves Chibon 1d610d
# SSH_KEYS = {'RSA': {'fingerprint': '<foo>', 'pubkey': '<bar>'}}</bar></foo>
Pierre-Yves Chibon 3adf88
Pierre-Yves Chibon 3adf88
Pierre-Yves Chibon 3adf88
Pierre-Yves Chibon 156357
# Optional configuration
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 771fcc
### Number of items displayed per page
Pierre-Yves Chibon 771fcc
# Used when listing items
Pierre-Yves Chibon 771fcc
ITEM_PER_PAGE = 50
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 771fcc
### Maximum size of the uploaded content
Pierre-Yves Chibon 771fcc
# Used to limit the size of file attached to a ticket for example
Pierre-Yves Chibon 771fcc
MAX_CONTENT_LENGTH = 4 * 1024 * 1024  # 4 megabytes
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 771fcc
### Lenght for short commits ids or file hex
Pierre-Yves Chibon 771fcc
SHORT_LENGTH = 6
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 771fcc
### List of blacklisted project names that can conflicts for pagure's URLs
Pierre-Yves Chibon 771fcc
### or other
Pierre-Yves Chibon 5b2543
BLACKLISTED_PROJECTS = [
Pierre-Yves Chibon 5b2543
    'static', 'pv', 'releases', 'new', 'api', 'settings',
Gaurav Kumar ca8e11
    'logout', 'login', 'users', 'groups', 'projects']
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 77273a
### IP addresses allowed to access the internal endpoints
Pierre-Yves Chibon 77273a
### These endpoints are used by the milter and are security sensitive, thus
Pierre-Yves Chibon 77273a
### the IP filter
Pierre-Yves Chibon 77273a
IP_ALLOWED_INTERNAL = ['127.0.0.1', 'localhost', '::1']
Pierre-Yves Chibon 77273a
Pierre-Yves Chibon 5b2543
### EventSource/Web-Hook/Redis configuration
Pierre-Yves Chibon 509340
# The eventsource integration is what allows pagure to refresh the content
Pierre-Yves Chibon 509340
# on your page when someone else comments on the ticket (and this without
Pierre-Yves Chibon 509340
# asking you to reload the page.
Pierre-Yves Chibon 4fb0af
# By default it is off, ie: EVENTSOURCE_SOURCE is None, to turn it on, specify
Pierre-Yves Chibon 4fb0af
# here what the URL of the eventsource server is, for example:
Pierre-Yves Chibon 4fb0af
# https://ev.pagure.io or https://pagure.io:8080 or whatever you are using
Pierre-Yves Chibon 4c012f
# (Note: the urls sent to it start with a '/' so no need to add one yourself)
Pierre-Yves Chibon 509340
EVENTSOURCE_SOURCE = None
Pierre-Yves Chibon bbab7a
# Port where the event source server is running (maybe be the same port
Pierre-Yves Chibon bbab7a
# as the one specified in EVENTSOURCE_SOURCE or a different one if you
Pierre-Yves Chibon bbab7a
# have something running in front of the server such as apache or stunnel).
Pierre-Yves Chibon bbab7a
EVENTSOURCE_PORT = 8080
Pierre-Yves Chibon 134f0e
# If this port is specified, the event source server will run another server
Pierre-Yves Chibon 134f0e
# at this port and will provide information about the number of active
Pierre-Yves Chibon 134f0e
# connections running on the first (main) event source server
Pierre-Yves Chibon 134f0e
#EV_STATS_PORT = 8888
Pierre-Yves Chibon 5b2543
# Web-hook can be turned on or off allowing using them for notifications, or
Pierre-Yves Chibon 5b2543
# not.
Pierre-Yves Chibon 5b2543
WEBHOOK = False
Pierre-Yves Chibon 5b2543
Pierre-Yves Chibon 5b2543
### Redis configuration
Pierre-Yves Chibon 5b2543
# A redis server is required for both the Event-Source server or the web-hook
Pierre-Yves Chibon 5b2543
# server.
Pierre-Yves Chibon 5b2543
REDIS_HOST = '0.0.0.0'
Pierre-Yves Chibon 5b2543
REDIS_PORT = 6379
Pierre-Yves Chibon 5b2543
REDIS_DB = 0
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 771fcc
# Authentication related configuration option
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 771fcc
### Switch the authentication method
Neal Gompa 8bcba6
# Specify which authentication method to use.
Neal Gompa 8bcba6
# Available options: `fas`, `openid`, `oidc`, `local`
Neal Gompa 8bcba6
# Default: ``local``.
Neal Gompa 8bcba6
PAGURE_AUTH = 'local'
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 771fcc
# When this is set to True, the session cookie will only be returned to the
Pierre-Yves Chibon 771fcc
# server via ssl (https). If you connect to the server via plain http, the
Pierre-Yves Chibon 771fcc
# cookie will not be sent. This prevents sniffing of the cookie contents.
Pierre-Yves Chibon 771fcc
# This may be set to False when testing your application but should always
Pierre-Yves Chibon 771fcc
# be set to True in production.
Pierre-Yves Chibon 771fcc
# Default: ``True``.
Pierre-Yves Chibon 771fcc
SESSION_COOKIE_SECURE = False
Pierre-Yves Chibon 771fcc
Pierre-Yves Chibon 771fcc
# The name of the cookie used to store the session id.
Pierre-Yves Chibon 771fcc
# Default: ``.pagure``.
Pierre-Yves Chibon 771fcc
SESSION_COOKIE_NAME = 'pagure'
Pierre-Yves Chibon 771fcc
bruno 6fae38
# Boolean specifying whether to check the user's IP address when retrieving
Pierre-Yves Chibon 771fcc
# its session. This make things more secure (thus is on by default) but
Pierre-Yves Chibon 771fcc
# under certain setup it might not work (for example is there are proxies
Pierre-Yves Chibon 771fcc
# in front of the application).
Pierre-Yves Chibon 771fcc
CHECK_SESSION_IP = True
Pierre-Yves Chibon 156357
Pierre-Yves Chibon 771fcc
# Used by SESSION_COOKIE_PATH
Pierre-Yves Chibon 771fcc
APPLICATION_ROOT = '/'
Pierre-Yves Chibon d642d8
Pierre-Yves Chibon d642d8
# Allow the backward compatiblity endpoints for the old URLs schema to
Pierre-Yves Chibon d642d8
# see the commits of a repo. This is only interesting if you pagure instance
Pierre-Yves Chibon 50c52b
# was running since before version 1.3 and if you care about backward
Pierre-Yves Chibon d642d8
# compatibility in your URLs.
Pierre-Yves Chibon d642d8
OLD_VIEW_COMMIT_ENABLED = False