parameters.php.dist (10374B)
1 <?php 2 3 /*********************************************************************************************************************** 4 * This is an example file for all PartKeepr-related configuration options. 5 * 6 * PartKeepr sets all relevant Symfony2 configurations via this file. If you require more flexibility for your setup, 7 * create an app/config/config_custom.yml file which will be parsed if it exists. 8 * 9 **********************************************************************************************************************/ 10 11 //====================================================================================================================== 12 // Database Settings 13 //====================================================================================================================== 14 15 /** 16 * Specifies the database driver. Available options are listed on this page: 17 * http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#driver 18 */ 19 $container->setParameter('database_driver', 'pdo_mysql'); 20 21 /** 22 * Specifies the hostname for the database 23 */ 24 $container->setParameter('database_host', 'localhost'); 25 /** 26 * Specifies the database port. 27 */ 28 $container->setParameter('database_port', '3306'); 29 30 /** 31 * Specifies the database name 32 */ 33 $container->setParameter('database_name', 'symfony'); 34 35 /** 36 * Specifies the username for the database 37 */ 38 $container->setParameter('database_user', 'root'); 39 40 /** 41 * Specifies the password for the database 42 */ 43 $container->setParameter('database_password', null); 44 45 //====================================================================================================================== 46 // Mailer Settings 47 // Currently not used, the defaults are fine 48 //====================================================================================================================== 49 50 // The mailer transport. Can be smtp, mail, sendmail or gmail 51 $container->setParameter('mailer_transport', null); 52 53 // The mail server host name or IP 54 $container->setParameter('mailer_host', null); 55 56 // The mail server port to use 57 $container->setParameter('mailer_port', null); 58 59 // The encryption method to use. Can be ssl, tls or null for unencrypted mail transport 60 $container->setParameter('mailer_encryption', null); 61 62 // The mail server username 63 $container->setParameter('mailer_user', null); 64 65 // The mail server password 66 $container->setParameter('mailer_password', null); 67 68 // The mail server auth mode. Can be plain, login or cram-md5 69 $container->setParameter('mailer_auth_mode', null); 70 71 //====================================================================================================================== 72 // Misc framework settings 73 //====================================================================================================================== 74 75 // The locale to use. Currently only en is supported 76 $container->setParameter('locale', 'en'); 77 78 // The secret. See http://symfony.com/doc/current/reference/configuration/framework.html#secret 79 $container->setParameter('secret', 'COAAFJGGLPHPDGGNCNILHFGECFMMACKC'); 80 81 //====================================================================================================================== 82 // LDAP Configuration 83 // Example for Active Directory: 84 // https://github.com/Maks3w/FR3DLdapBundle/blob/master/Resources/doc/cookbook/active-directory.md 85 //====================================================================================================================== 86 87 // The LDAP Server Host 88 $container->setParameter('fr3d_ldap.driver.host', '127.0.0.1'); 89 90 // The LDAP Sever Port 91 $container->setParameter('fr3d_ldap.driver.port', null); 92 93 // The username to use for LDAP queries 94 $container->setParameter('fr3d_ldap.driver.username', null); 95 96 // The password to use for LDAP queries 97 $container->setParameter('fr3d_ldap.driver.password', null); 98 99 // true to require a DN for binding attemts, false otherwise 100 $container->setParameter('fr3d_ldap.driver.bindRequiresDn', false); 101 102 // The base DN to query for users 103 $container->setParameter('fr3d_ldap.driver.baseDn', ''); 104 105 // sprintf format %s will be the username 106 $container->setParameter('fr3d_ldap.driver.accountFilterFormat', null); 107 108 $container->setParameter('fr3d_ldap.driver.optReferrals', null); 109 110 // true to use SSL, false otherwise 111 $container->setParameter('fr3d_ldap.driver.useSsl', null); 112 113 // true to use startTls, false otherwise 114 $container->setParameter('fr3d_ldap.driver.useStartTls', null); 115 116 // currently not used 117 $container->setParameter('fr3d_ldap.driver.accountCanonicalForm', null); 118 119 $container->setParameter('fr3d_ldap.driver.accountDomainName', null); 120 $container->setParameter('fr3d_ldap.driver.accountDomainNameShort', null); 121 122 // set to true to enable LDAP 123 $container->setParameter('fr3d_ldap.user.enabled', false); 124 125 // sets the base DN 126 $container->setParameter('fr3d_ldap.user.baseDn', 'dc=blabla,dc=com'); 127 128 // The filter to use for queries 129 $container->setParameter('fr3d_ldap.user.filter', null); 130 131 // The username attribute 132 $container->setParameter('fr3d_ldap.user.attribute.username', "samaccountname"); 133 134 // The email attribute 135 $container->setParameter('fr3d_ldap.user.attribute.email', "email"); 136 137 138 //====================================================================================================================== 139 // PartKeepr settings 140 //====================================================================================================================== 141 142 // The authentication provider to use. Can be either PartKeepr.Auth.WSSEAuthenticationProvider or 143 // PartKeepr.Auth.HTTPBasicAuthenticationProvider 144 $container->setParameter('authentication_provider', 'PartKeepr.Auth.WSSEAuthenticationProvider'); 145 146 /** 147 * Specifies if the frontend should perform an auto-login 148 */ 149 $container->setParameter('partkeepr.frontend.auto_login.enabled', false); 150 151 /** 152 * Specifies the auto-login username 153 */ 154 $container->setParameter('partkeepr.frontend.auto_login.username', 'admin'); 155 156 /** 157 * Specifies the auto-login password 158 */ 159 $container->setParameter('partkeepr.frontend.auto_login.password', 'admin'); 160 161 /** 162 * Specifies the base_url for the PartKeepr frontend. 163 * Usually this is not required, but if you run PartKeepr behind a reverse 164 * proxy with a different path, you can set it here. 165 * 166 * Please note that you need to create an additional file, see 167 * https://wiki.partkeepr.org/wiki/KB00008:PartKeepr_behind_a_reverse_proxy 168 * 169 * Example: If PartKeepr runs on / within a docker container and your reverse 170 * proxy maps it on https://www.example.org/parts, you can set the 171 * base_url to https://www.example.org/parts 172 */ 173 $container->setParameter('partkeepr.frontend.base_url', false); 174 175 /** 176 * Specifies the category path separator 177 */ 178 $container->setParameter('partkeepr.category.path_separator', ' ➤ '); 179 180 /** 181 * Specifies a message of the day. Set to any string instead of false 182 * to display a MOTD. Example 183 * $container->setParameter('partkeepr.frontend.motd', "This is a MOTD"); 184 */ 185 $container->setParameter('partkeepr.frontend.motd', false); 186 187 /** 188 * Specifies if a quota should be used. 189 * If set to false, no quota is used. Set it to a numeric value to set a quota in bytes. 190 */ 191 $container->setParameter('partkeepr.filesystem.quota', false); 192 193 /** 194 * Specifies the dunglas cache. Defaults to false. 195 * You can use the APCu cache by specifying "api.mapping.cache.apc" here. 196 * 197 * Further reading: https://api-platform.com/doc/1.0/api-bundle/performances 198 */ 199 $container->setParameter('cache.dunglas', false); 200 201 /** 202 * Specifies the doctrine cache. Defaults to "array", but can be "apc". 203 * 204 * Further reading: http://symfony.com/doc/current/bundles/DoctrineBundle/configuration.html#caching-drivers 205 * 206 * For complex caching scenarios, you are advised to use a custom configuration file as described at the top of this 207 * file. 208 */ 209 $container->setParameter('cache.doctrine', 'array'); 210 211 /** 212 * Defines if a maintenance page should be displayed. 213 */ 214 $container->setParameter('partkeepr.maintenance', false); 215 216 /** 217 * Defines if a maintenance page should be displayed. Set to false to prevent a maintenance page being 218 * displayed, or to a string which should occur on the maintenance page. 219 */ 220 $container->setParameter('partkeepr.maintenance.title', ''); 221 222 /** 223 * Defines if a maintenance page should be displayed. Set to false to prevent a maintenance page being 224 * displayed, or to a string which should occur on the maintenance page. 225 */ 226 $container->setParameter('partkeepr.maintenance.message', ''); 227 228 /** 229 * Defines a limit for the maximum amount of users allowed. Valid values are false (no limit) or an integer number 230 */ 231 $container->setParameter('partkeepr.users.limit', false); 232 233 /** 234 * Defines a limit for the maximum amount of parts allowed. Valid values are false (no limit) or an integer number 235 */ 236 $container->setParameter('partkeepr.parts.limit', false); 237 238 /** 239 * Defines if the internal part number must be unique or not. Note that empty internal part numbers aren't checked - 240 * if you require to enforce an internal part number, also set the field internalPartNumber to mandatory. 241 * 242 * Defaults to false 243 */ 244 $container->setParameter('partkeepr.parts.internalpartnumberunique', false); 245 246 /** 247 * Defines a limit for the maximum amount of parts allowed. Valid values are false (no limit) or an integer number 248 */ 249 $container->setParameter('partkeepr.upload.limit', false); 250 251 /** 252 * Specifies the PartKeepr data directory 253 */ 254 $container->setParameter('partkeepr.filesystem.data_directory', '%kernel.root_dir%/../data/'); 255 256 /** 257 * Specifies if PartKeepr should check for non-running cronjobs 258 */ 259 $container->setParameter('partkeepr.cronjob.check', true); 260 261 /** 262 * Specifies which v4 API key PartKeepr should use to talk to OctoPart. You can get an API key by registering at 263 * https://octopart.com/api and then registering an application. 264 */ 265 $container->setParameter('partkeepr.octopart.apikey', ''); 266 267 /** 268 * The number of returned parts from API calls is limited. Try to keep this value low 269 */ 270 $container->setParameter('partkeepr.octopart.limit', '3'); 271 272 /** 273 * Specifies which URL contains the patreon status. If you do not wish to display the patreon status, 274 * set this parameter to false. Please note that we rely on your Patreon pledges to ensure further 275 * development of PartKeepr. 276 */ 277 $container->setParameter('partkeepr.patreon.statusuri', 'https://www.partkeepr.org/patreon.json');