diff --git a/conf/lstu.conf.template b/conf/lstu.conf.template new file mode 100644 index 0000000..78b6c45 --- /dev/null +++ b/conf/lstu.conf.template @@ -0,0 +1,121 @@ +# vim:set sw=4 ts=4 sts=4 ft=perl expandtab: +{ + #################### + # Hypnotoad settings + #################### + # see http://mojolicio.us/perldoc/Mojo/Server/Hypnotoad for a full list of settings + hypnotoad => { + # array of IP addresses and ports you want to listen to + listen => ['http://127.0.0.1:__PORT__'], + # if you use Lstu behind a reverse proxy like Nginx, you want to set proxy to 1 + # if you use Lstu directly, let it commented + #proxy => 1, + }, + + # put a way to contact you here and uncomment it + # MANDATORY + contact => 'webmaster@__DOMAIN__', + + # array of random strings used to encrypt cookies + # optional, default is ['fdjsofjoihrei'], PLEASE, CHANGE IT + secrets => ['__SECRET__'], + + # secret passphrase to access some admin features + # If you don't want to have a plain text password in configuration, + # use hashed_adminpwd instead + # optional, but you won't have access to admin /stats if not set and if hashed_adminpwd is not set either + #adminpwd => 's3cr3T', + + # secret hashed passphrase to access some admin features + # Hash your password by issuing `echo -n s3cr3T | sha256sum` on your terminal + # optional, but you won't have access to admin /stats if not set and if adminpwd is not set either + #hashed_adminpwd => '94b2feede6ea5e2eec62f457ecb7d3f719b24d19c29d4e5466246a31908fc23b', + + # choose a theme. See the available themes in `themes` directory + # optional, default is 'default' + theme => 'default', + + # number of URLs to be displayed per page in /stats + # optional, default is 10 + page_offset => 10, + + # length of the random URL + # optional, default is 8 + length => 8, + + # how many URLs will be provisioned in a batch ? + # optional, default is 5 + #provis_step => 5, + + # max number of URLs to be provisioned + # optional, default is 100 + #provisioning => 100, + + # URL sub-directory in which you want Lstu to be accessible + # example: you want to have Lstu under https://example.org/lstu/ + # => set prefix to '/lstu' or to '/lstu/', it doesn't matter + # optional, defaut is / + prefix => '__PATH__', + + # array of authorized domains for API calls. + # if you want to authorize everyone to use the API: ['*'] + # optional, no domains allowed by default + #allowed_domains => ['http://1.example.com', 'http://2.example.com'], + + # if set, the shortened URLs will use this domain + # optional + #fixed_domain => 'example.org', + + # define a path to the SQLite database + # you can define it relative to lstu directory or set an absolute path + # remember that it has to be in a directory writable by Lstu user + # optional, default is lstu.db + #db_path => 'lstu.db', + + # Rate-limiting for the API + # After ban_min_strike requests in a second, the IP address will be + # banned for one hour. + # If it continues to query the API during this ban time at least + # ban_min_strike times, it will be banned for a month. + # optional, default is 3 + ban_min_strike => 3, + + # define an URL to the Piwik instance and the ID of a website to track + # set if you want to track views in Piwik + # optional, Piwik tracking is disabled by default + #piwik => { + # url => 'http://piwik.example.com', + # idsite => '1', + #}, + + # use Minion instead of directly increase counters + # need to launch a minion worker service if enabled + # optional, Minion is disabled by default + #minion => { + # enabled => 0, + # db_path => 'minion.db' # you can define it relative to lstu directory or set an absolute path + #}, + + # set `ldap` if you want that only authenticated users can shorten URLs + # please note that everybody can still use shortend URLs + # optional, no default + #ldap => { + # uri => 'ldaps://ldap.example.org', + # user_tree => 'ou=users,dc=example,dc=org', + # bind_dn => ',ou=users,dc=example,dc=org', + # bind_user => 'uid=ldap_user', + # bind_pwd => 'secr3t', + # user_filter => '!(uid=ldap_user)' + #}, + + # set `htpasswd` if you want to use an htpasswd file instead of ldap + # create the file with `htpasswd -c lstu.passwd user`, update it with `htpasswd lstu.passwd user2` + # make sure that lstu can read the file! + # optional, no default + #htpasswd => 'lstu.passwd', + + # if you've set ldap or htpasswd above, the session will last `session_duration` seconds before + # the user needs to reauthenticate + # optional, default is 3600 + #session_duration => 3600, +};