DRCIT/snipe-it
1
0
Fork 0
mirror of https://github.com/snipe/snipe-it.git synced 2024-09-19 23:37:38 -07:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Add descriptions for some env vars

Browse source
This commit is contained in:
Jason Spriggs 2021-09-08 20:51:43 -04:00
parent 48374f0854
commit acefb3d1b9
2 changed files with 42 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
app.json
View file

@ -7,15 +7,19 @@
], ],
"website": "https://snipeitapp.com/", "website": "https://snipeitapp.com/",
"repository": "https://github.com/snipe/snipe-it", "repository": "https://github.com/snipe/snipe-it",
"logo": "https://snipeitapp.com/img/logos/snipe-it-logo-xs.png", "logo": "https://pbs.twimg.com/profile_images/976748875733020672/K-HnZCCK_400x400.jpg",
"success_url": "/setup", "success_url": "/setup",
"env": { "env": {
"APP_ENV": { "APP_ENV": {
"description": "Symfony environment mode.", "description": "Symfony environment mode. Unless developing the application, this should be production.",
"value": "production" "value": "production"
}, },
"APP_DEBUG": {
"description": "Symfony debug mode. Unless developing the application or actively debugging a problem, this should be set to false.",
"value": "false"
},
"APP_KEY": { "APP_KEY": {
"description": "A secret key for verifying the integrity of signed cookies. (https://coderstoolbox.online/toolbox/generate-symfony-secret)", "description": "A secret key for verifying the integrity of signed cookies. (See either https://snipe-it.readme.io/docs/install-dependencies or generate at https://coderstoolbox.online/toolbox/generate-symfony-secret)",
"value": "" "value": ""
}, },
"APP_URL": { "APP_URL": {
@ -30,84 +34,88 @@
"description": "Which language do you want to use for your install? (https://snipe-it.readme.io/docs/configuration#setting-a-language)", "description": "Which language do you want to use for your install? (https://snipe-it.readme.io/docs/configuration#setting-a-language)",
"value": "en" "value": "en"
}, },
"MAX_RESULTS": {
"description": "The maximum number of search results that can be returned at one time.",
"value": "500"
},
"MAIL_DRIVER": { "MAIL_DRIVER": {
"description": "", "description": "Mail driver - Generally SMTP on Heroku - https://snipe-it.readme.io/docs/configuration#required-outgoing-mail-settings",
"value": "smtp" "value": "smtp"
}, },
"MAIL_HOST": { "MAIL_HOST": {
"description": "", "description": "SMTP Server Hostname",
"value": "smtp.your.domain.name" "value": "smtp.your.domain.name"
}, },
"MAIL_PORT": { "MAIL_PORT": {
"description": "", "description": "SMTP Server Port",
"value": "25" "value": "25"
}, },
"MAIL_USERNAME": { "MAIL_USERNAME": {
"description": "", "description": "SMTP Server Username",
"value": "YOURUSERNAME" "value": "YOURUSERNAME"
}, },
"MAIL_PASSWORD": { "MAIL_PASSWORD": {
"description": "", "description": "SMTP Server Password",
"value": "YOURPASSWORD" "value": "YOURPASSWORD"
}, },
"MAIL_ENCRYPTION": { "MAIL_ENCRYPTION": {
"description": "", "description": "Encryption protocol for email sending.",
"value": "null" "value": "null"
}, },
"MAIL_FROM_ADDR": { "MAIL_FROM_ADDR": {
"description": "", "description": "Email from address",
"value": "your@domain.name" "value": "no-reply@domain.name"
}, },
"MAIL_FROM_NAME": { "MAIL_FROM_NAME": {
"description": "", "description": "Email from Name",
"value": "Snipe-IT" "value": "Snipe-IT"
}, },
"MAIL_REPLYTO_ADDR": { "MAIL_REPLYTO_ADDR": {
"description": "", "description": "Email Reply-To address",
"value": "your@domain.name" "value": "your@domain.name"
}, },
"MAIL_REPLYTO_NAME": { "MAIL_REPLYTO_NAME": {
"description": "", "description": "Email Reply-To Name",
"value": "Snipe-IT" "value": "Snipe-IT"
}, },
"MAIL_AUTO_EMBED": { "MAIL_AUTO_EMBED": {
"description": "", "description": "Whether or not to embed images in emails (via CID or base64) versus linking to them.",
"value": "true" "value": "true"
}, },
"MAIL_AUTO_EMBED_METHOD": { "MAIL_AUTO_EMBED_METHOD": {
"description": "", "description": "Method that should be used for attaching inline images.",
"value": "base64" "value": "base64"
}, },
"SESSION_LIFETIME": { "SESSION_LIFETIME": {
"description": "", "description": "Specify the time in minutes that the session should remain valid.",
"value": "12000" "value": "12000"
}, },
"EXPIRE_ON_CLOSE": { "EXPIRE_ON_CLOSE": {
"description": "", "description": "Specify whether or not the logged in session should be expired when the user closes their browser window.",
"value": "false" "value": "false"
}, },
"ENCRYPT": { "ENCRYPT": {
"description": "", "description": "Specify whether you wish to use encrypted cookies for your Snipe-IT sessions.",
"value": "false" "value": "true"
}, },
"COOKIE_NAME": { "COOKIE_NAME": {
"description": "", "description": "The name of the cookie set by Snipe-IT for session management.",
"value": "snipeit_session" "value": "snipeit_session"
}, },
"COOKIE_DOMAIN": { "COOKIE_DOMAIN": {
"description": "", "description": "The domain name that the session cookie should be sent for.",
"value": "your-app-name.herokuapp.com" "value": "your-app-name.herokuapp.com"
}, },
"SECURE_COOKIES": { "SECURE_COOKIES": {
"description": "", "description": "Should cookies only be sent for HTTPS connections? Generally true on Heroku.",
"value": "false" "value": "true"
}, },
"LOGIN_MAX_ATTEMPTS": { "LOGIN_MAX_ATTEMPTS": {
"description": "", "description": "The maximum number of failed attempts allowed before the user is throttled.",
"value": "5" "value": "5"
}, },
"LOGIN_LOCKOUT_DURATION": { "LOGIN_LOCKOUT_DURATION": {
"description": "", "description": "The duration (in seconds) that the user should be blocked from attempting to authenticate again.",
"value": "60" "value": "60"
}, },
"APP_LOG": { "APP_LOG": {
@ -115,19 +123,19 @@
"value": "errorlog" "value": "errorlog"
}, },
"ALLOW_IFRAMING": { "ALLOW_IFRAMING": {
"description": "", "description": "Allow Snipe-IT to be loaded using an iFrame?",
"value": "false" "value": "false"
}, },
"GOOGLE_MAPS_API": { "GOOGLE_MAPS_API": {
"description": "", "description": "Include your Google Maps API key here if you'd like Snipe-IT to load maps from Google on your locations and suppliers pages.",
"value": "" "required": false
}, },
"BACKUP_ENV": { "BACKUP_ENV": {
"description": "", "description": "Set this to true if you wish to backup your .env file in your Admin > Backups process.",
"value": "true" "value": "true"
}, },
"ENABLE_HSTS": { "ENABLE_HSTS": {
"description": "", "description": "Whether or not to send the HSTS security policy header.",
"value": "false" "value": "false"
} }
}, },

3
heroku/startup.php
View file

@ -20,6 +20,9 @@ function set_db($uri) {
file_put_contents('./.env', 'DB_USERNAME=' . parse_url($uri, PHP_URL_USER). PHP_EOL, FILE_APPEND); file_put_contents('./.env', 'DB_USERNAME=' . parse_url($uri, PHP_URL_USER). PHP_EOL, FILE_APPEND);
file_put_contents('./.env', 'DB_PASSWORD=' . parse_url($uri, PHP_URL_PASS). PHP_EOL, FILE_APPEND); file_put_contents('./.env', 'DB_PASSWORD=' . parse_url($uri, PHP_URL_PASS). PHP_EOL, FILE_APPEND);
file_put_contents('./.env', 'DB_DATABASE=' . ltrim(parse_url($uri, PHP_URL_PATH), '/'). PHP_EOL, FILE_APPEND); file_put_contents('./.env', 'DB_DATABASE=' . ltrim(parse_url($uri, PHP_URL_PATH), '/'). PHP_EOL, FILE_APPEND);
file_put_contents('./.env', 'DB_PREFIX=' . 'null' . PHP_EOL, FILE_APPEND);
file_put_contents('./.env', 'DB_DUMP_PATH=' . 'null' . PHP_EOL, FILE_APPEND);
} }
// If Heroku Redis is setup, let's get it working. // If Heroku Redis is setup, let's get it working.