TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-21 01:41:46 +03:00
Code Issues Projects Releases Wiki Activity
01633470f8
Ghost/core/server/data/schema/default-settings.json

274 lines
6.9 KiB
JSON
Raw Normal View History

Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
{
Updating settings types - issue #573, issue #632
2013-09-14 22:04:41 +04:00
"core": {
🎨 settings inconsistency (#8381) no issue - replace camelCase settings keys with underscore_case for consistency - discussed here https://github.com/TryGhost/Ghost-Admin/pull/661#discussion_r112939982
2017-04-24 20:41:00 +03:00
"db_hash": {
Fix 'dbHash' not found closes #1685 - changed dbHash initialization from db direct access to api access - added dbHash to default-settings.json - added dbHash to tests
2013-12-16 14:16:06 +04:00
"defaultValue": null
Add update notifications closes #1464 - adds opt-out via updateCheck:false in config.js - update check is done on admin index, but doesn't interfere with rendering - adds update check module, which gets the usage data, makes the request and handles the response - adds two new settings to default-settings, one for next check time, and one for whether to show the notification - adds a new rejectError method to errorHandling - adds a new helper for displaying the notification Conflicts: core/server/helpers/index.js core/test/unit/server_helpers_index_spec.js
2014-01-03 19:50:03 +04:00
},
🎨 settings inconsistency (#8381) no issue - replace camelCase settings keys with underscore_case for consistency - discussed here https://github.com/TryGhost/Ghost-Admin/pull/661#discussion_r112939982
2017-04-24 20:41:00 +03:00
"next_update_check": {
Add update notifications closes #1464 - adds opt-out via updateCheck:false in config.js - update check is done on admin index, but doesn't interfere with rendering - adds update check module, which gets the usage data, makes the request and handles the response - adds two new settings to default-settings, one for next check time, and one for whether to show the notification - adds a new rejectError method to errorHandling - adds a new helper for displaying the notification Conflicts: core/server/helpers/index.js core/test/unit/server_helpers_index_spec.js
2014-01-03 19:50:03 +04:00
"defaultValue": null
},
Update Notification improvements (#9123) closes #5071 - Remove hardcoded notification in admin controller - NOTE: update check notifications are no longer blocking the admin rendering - this is one of the most import changes - we remove the hardcoded release message - we also remove adding a notification manually in here, because this will work differently from now on -> you receive a notification (release or custom) in the update check module and this module adds the notification as is to our database - Change default core settings keys - remove displayUpdateNotification -> this was used to store the release version number send from the UCS -> based on this value, Ghost creates a notification container with self defined values -> not needed anymore - rename seenNotifications to notifications -> the new notifications key will hold both 1. the notification from the USC 2. the information about if a notification was seen or not - this key hold only one release notification - and n custom notifications - Update Check Module: Request to the USC depends on the privacy configuration - useUpdateCheck: true -> does a checkin in the USC (exposes data) - useUpdateCheck: false -> does only a GET query to the USC (does not expose any data) - make the request handling dynamic, so it depends on the flag - add an extra logic to be able to define a custom USC endpoint (helpful for testing) - add an extra logic to be able to force the request to the service (helpful for testing) - Update check module: re-work condition when a check should happen - only if the env is not correct - remove deprecated config.updateCheck - remove isPrivacyDisabled check (handled differently now, explained in last commit) - Update check module: remove `showUpdateNotification` and readability - showUpdateNotification was used in the admin controller to fetch the latest release version number from the db - no need to check against semver in general, the USC takes care of that (no need to double check) - improve readability of `nextUpdateCheck` condition - Update check module: refactor `updateCheckResponse` - remove db call to displayUpdateNotification, not used anymore - support receiving multiple custom notifications - support custom notification groups - the default group is `all` - this will always be consumed - groups can be extended via config e.g. `notificationGroups: ['migration']` - Update check module: refactor createCustomNotification helper - get rid of taking over notification duplication handling (this is not the task of the update check module) - ensure we have good fallback values for non present attributes in a notification - get rid of semver check (happens in the USC) - could be reconsidered later if LTS is gone - Refactor notification API - reason: get rid of in process notification store -> this was an object hold in process -> everything get's lost after restart -> not helpful anymore, because imagine the following case -> you get a notification -> you store it in process -> you mark this notification as seen -> you restart Ghost, you will receive the same notification on the next check again -> because we are no longer have a separate seen notifications object - use database settings key `notification` instead - refactor all api endpoints to support reading and storing into the `notifications` object - most important: notification deletion happens via a `seen` property (the notification get's physically deleted 3 month automatically) -> we have to remember a seen property, because otherwise you don't know which notification was already received/seen - Add listener to remove seen notifications automatically after 3 month - i just decided for 3 month (we can decrease?) - at the end it doesn't really matter, as long as the windows is not tooooo short - listen on updates for the notifications settings - check if notification was seen and is older than 3 month - ignore release notification - Updated our privacy document - Updated docs.ghost.org for privacy config behaviour - contains a migration script to remove old settings keys
2018-01-09 17:20:00 +03:00
"notifications": {
Support for custom notifications (#7077) closes #5071 - Send application/json requests to UpdateCheck service. New UpdateCheck service accepts JSON request - If UpdateCheck service respponse has messages[] array, iterate over the array and create custom notifications intended for current version - Save custom notification if its not already in the store AND its uuid is not in seenNotifications array - When a custom notification is dismissed, store its uuid in seenNotifications array - setup test fixtures to trigger tests properly - api_notification_spec test to ensure custom notification can be added to store and added to seenNotifications when dismissed - update_check_spec test to ensure custom notification can be displayed for a specific Ghost version - added test to ensure messages meant for other versions don't create notifications
2016-07-22 16:02:10 +03:00
"defaultValue": "[]"
Added session_secret setting to schema (#9953) closes #9952 - required by the express-session middleware
2018-10-05 14:25:51 +03:00
},
"session_secret": {
"defaultValue": null
Updated theme layer to use members-ssr (#10676) * Removed support for cookies in members auth middleware no-issue The members middleware will no longer be supporting cookies, the cookie will be handled by a new middleware specific for serverside rendering, more informations can be found here: https://paper.dropbox.com/doc/Members-Auth-II-4WP4vF6coMqDYbSMIajo5 * Removed members auth middleware from site app no-issue The site app no longer needs the members auth middleware as it doesn't support cookies, and will be replaced by ssr specific middleware. https://paper.dropbox.com/doc/Members-Auth-II-4WP4vF6coMqDYbSMIajo5 * Added comment for session_secret setting no-issue We are going to have multiple concepts of sessions, so adding a comment here to be specific that this is for the Ghost Admin client * Added theme_session_secret setting dynamic default no-issue Sessions for the theme layer will be signed, so we generate a random hex string to use as a signing key * Added getPublicConfig method * Replaced export of httpHandler with POJO apiInstance no-issue This is mainly to reduce the public api, so it's easier to document. * Renamed memberUserObject -> members no-issue Simplifies the interface, and is more inline with what we would want to export as an api library. * Removed use of require options inside members no-issue This was too tight of a coupling between Ghost and Members * Simplified apiInstance definition no-issue * Added getMember method to members api * Added MembersSSR instance to members service * Wired up routes for members ssr * Updated members auth middleware to use getPublicConfig * Removed publicKey static export from members service * Used real session secret no-issue * Added DELETE /members/ssr handler no-issue This allows users to log out of the theme layer * Fixed missing code property no-issue Ignition uses the statusCode property to forward status codes to call sites * Removed superfluous error middleware no-issue Before we used generic JWT middleware which would reject, now the middleware catches it's own error and doesn't error, thus this middleware is unecessary. * Removed console.logs no-issue * Updated token expirty to hardcoded 20 minutes no-issue This returns to our previous state of using short lived tokens, both for security and simplicity. * Removed hardcoded default member settings no-issue This is no longer needed, as defaults are in default-settings.json * Removed stripe from default payment processor no-issue * Exported `getSiteUrl` method from url utils no-issue This keeps inline with newer naming conventions * Updated how audience access control works no-issue Rather than being passed a function, members api now receives an object which describes which origins have access to which audiences, and how long those tokens should be allowed to work for. It also allows syntax for default tokens where audience === origin requesting it. This can be set to undefined or null to disable this functionality. { "http://site.com": { "http://site.com": { tokenLength: '5m' }, "http://othersite.com": { tokenLength: '1h' } }, "*": { tokenLength: '30m' } } * Updated members service to use access control feature no-issue This also cleans up a lot of unecessary variable definitions, and some other minor cleanups. * Added status code to auth pages html response no-issue This was missing, probably default but better to be explicit * Updated gateway to have membersApiUrl from config no-issue Previously we were parsing the url, this was not very safe as we can have Ghost hosted on a subdomain, and this would have failed. * Added issuer to public config for members no-issue This can be used to request SSR tokens in the client * Fixed path for gateway bundle no-issue * Updated settings model tests no-issue * Revert "Removed stripe from default payment processor" This reverts commit 1d88d9b6d73a10091070bcc1b7f5779d071c7845. * Revert "Removed hardcoded default member settings" This reverts commit 9d899048ba7d4b272b9ac65a95a52af66b30914a. * Installed @tryghost/members-ssr * Fixed tests for settings model
2019-04-16 17:50:25 +03:00
},
"theme_session_secret": {
"defaultValue": null
Implemented externally verifiable identity tokens no-issue This adds two new endpoints, one at /ghost/.well-known/jwks.json for exposing a public key, and one on the canary api /identities, which allows the Owner user to fetch a JWT. This token can then be used by external services to verify the domain * Added ghost_{public,private}_key settings This key can be used for generating tokens for communicating with external services on behalf of Ghost * Added .well-known directory to /ghost/.well-known We add a jwks.json file to the .well-known directory which exposes a public JWK which can be used to verify the signatures of JWT's created by Ghost This is added to the /ghost/ path so that it can live on the admin domain, rather than the frontend. This is because most of its uses/functions will be in relation to the admin domain. * Improved settings model tests This removes hardcoded positions in favour of testing that a particular event wasn't emitted which is less brittle and more precise about what's being tested * Fixed parent app unit tests for well-known This updates the parent app unit tests to check that the well-known route is mounted. We all change proxyquire to use `noCallThru` which ensures that the ubderlying modules are not required. This stops the initialisation logic in ./well-known erroring in tests https://github.com/thlorenz/proxyquire/issues/215 * Moved jwt signature to a separate 'token' propery This structure corresponds to other resources and allows to exptend with additional properties in future if needed
2020-01-20 14:45:58 +03:00
},
"ghost_public_key": {
"defaultValue": null
},
"ghost_private_key": {
"defaultValue": null
Organised default settings into new groups (#11952) refs https://github.com/TryGhost/Ghost/issues/10318 - precursor to migrating from `settings.type` to `settings.group` - renames `blog` type to `site` - renames `bulk_email` type to `email` - moves settings out of `site` (previously `blog`) into more appropriate groups such as `core` or individual feature groups
2020-06-23 22:49:08 +03:00
},
"members_public_key": {
"defaultValue": null
},
"members_private_key": {
"defaultValue": null
},
"members_email_auth_secret": {
"defaultValue": null
Updating settings types - issue #573, issue #632
2013-09-14 22:04:41 +04:00
}
},
Organised default settings into new groups (#11952) refs https://github.com/TryGhost/Ghost/issues/10318 - precursor to migrating from `settings.type` to `settings.group` - renames `blog` type to `site` - renames `bulk_email` type to `email` - moves settings out of `site` (previously `blog`) into more appropriate groups such as `core` or individual feature groups
2020-06-23 22:49:08 +03:00
"site": {
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
"title": {
Set soft limits for blog title and description (#9250) refs #8143 Add max length validations to settings: - `blog.title`: 150 chars - `blog.description`: 200 chars The `validateSettings` fn in our validations checks for existing `validations` properties in our `default-settings.json` file, similar to other tables in our `schema.js`.
2017-11-16 15:58:22 +03:00
"defaultValue": "Ghost",
"validations": {
"isLength": {
"max": 150
}
Added migration to populate settings.{group,flags} (#11954) refs https://github.com/TryGhost/Ghost/issues/10318 - maps old `settings.type` values to new `settings.type/group` values - uses an explicit map so that we don't lose information and can safely roll back even though we're modifying `settings.type` too - updates `settings.type` values too to keep code working while we switch to using `settings.group` - sets the `settings.group` value for all settings which are keeping the same group as their current type - adapts `settings.type` validations to match new groups - adds flags to specific settings, both in the migration for existing settings records and in default-settings.json for new settings records
2020-06-24 14:38:18 +03:00
},
"flags": "PUBLIC"
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
},
"description": {
Set soft limits for blog title and description (#9250) refs #8143 Add max length validations to settings: - `blog.title`: 150 chars - `blog.description`: 200 chars The `validateSettings` fn in our validations checks for existing `validations` properties in our `default-settings.json` file, similar to other tables in our `schema.js`.
2017-11-16 15:58:22 +03:00
"defaultValue": "The professional publishing platform",
"validations": {
"isLength": {
"max": 200
}
Added migration to populate settings.{group,flags} (#11954) refs https://github.com/TryGhost/Ghost/issues/10318 - maps old `settings.type` values to new `settings.type/group` values - uses an explicit map so that we don't lose information and can safely roll back even though we're modifying `settings.type` too - updates `settings.type` values too to keep code working while we switch to using `settings.group` - sets the `settings.group` value for all settings which are keeping the same group as their current type - adapts `settings.type` validations to match new groups - adds flags to specific settings, both in the migration for existing settings records and in default-settings.json for new settings records
2020-06-24 14:38:18 +03:00
},
"flags": "PUBLIC"
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
},
"logo": {
Changed casper.ghost.org to static.ghost.org references (#10109) no issue Assets moved from gh-pages to https://github.com/tryghost/static and hostname changed, redirects already in place. Can be tested on https://demo.ghost.io (image should all work fine, try visiting one directly to verify redirect works)
2018-11-07 17:50:38 +03:00
"defaultValue": "https://static.ghost.org/v1.0.0/images/ghost-logo.svg"
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
},
🙀 Image field naming & new img_url helper (#8364) * 🙀 change database schema for images - rename user/post/tag images - contains all the required changes from the schema change * Refactor helper/meta data - rename cover to cover_image - also rename default settings to match the pattern - rename image to profile_image for user - rename image to feature_image for tags/posts * {{image}} >>> {{img_url}} - rename - change the functionality - attr is required - e.g. {{img_url feature_image}} * gscan 1.0.0 - update yarn.lock * Update casper reference: 1.0-changes - see https://github.com/TryGhost/Casper/commit/5487b4da8d2ad7c6a6d003a3a0ee1a860e0de34d
2017-04-24 20:21:47 +03:00
"cover_image": {
💄Updated fixtures for Ghost v3 content + assets (#11247) no issue - Updated post images and content - Updated default blog cover asset - Updated default Ghost user avatar
2019-10-17 11:49:30 +03:00
"defaultValue": "https://static.ghost.org/v3.0.0/images/publication-cover.png"
✨ Find favicon in Ghost (#7713) refs #7688 Adds logic in theme settings api to either serve an uploaded favicon and give it the type `upload` or use the default settings `default`, which will serve the favicon from our shared directory. TODOs for #7688: - [X] Figure out, which favicon should be used (uploaded or default) -> this PR - [ ] Serve and redirect the favicon for any browser requests, incl. redirects - [ ] Upload favicon via `general/settings` and implement basic admin validations -> [WIP] TryGhost/Ghost-Admin#397 - [ ] Built server side validations
2017-01-23 12:13:52 +03:00
},
🐷 Rename 'favicon' to 'icon' (#7888) refs TryGhost/Ghost#7688 Just renames `favicon` to `icon` as our usage for it will not be for favicon purposes only.
2017-01-25 13:02:02 +03:00
"icon": {
✨ Find favicon in Ghost (#7713) refs #7688 Adds logic in theme settings api to either serve an uploaded favicon and give it the type `upload` or use the default settings `default`, which will serve the favicon from our shared directory. TODOs for #7688: - [X] Figure out, which favicon should be used (uploaded or default) -> this PR - [ ] Serve and redirect the favicon for any browser requests, incl. redirects - [ ] Upload favicon via `general/settings` and implement basic admin validations -> [WIP] TryGhost/Ghost-Admin#397 - [ ] Built server side validations
2017-01-23 12:13:52 +03:00
"defaultValue": ""
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
},
Organised default settings into new groups (#11952) refs https://github.com/TryGhost/Ghost/issues/10318 - precursor to migrating from `settings.type` to `settings.group` - renames `blog` type to `site` - renames `bulk_email` type to `email` - moves settings out of `site` (previously `blog`) into more appropriate groups such as `core` or individual feature groups
2020-06-23 22:49:08 +03:00
"accent_color": {
Added migration to populate settings.{group,flags} (#11954) refs https://github.com/TryGhost/Ghost/issues/10318 - maps old `settings.type` values to new `settings.type/group` values - uses an explicit map so that we don't lose information and can safely roll back even though we're modifying `settings.type` too - updates `settings.type` values too to keep code working while we switch to using `settings.group` - sets the `settings.group` value for all settings which are keeping the same group as their current type - adapts `settings.type` validations to match new groups - adds flags to specific settings, both in the migration for existing settings records and in default-settings.json for new settings records
2020-06-24 14:38:18 +03:00
"defaultValue": "",
"flags": "PUBLIC"
✨ Added new brand blog setting (#11408) no issue Adds new `brand: {primary_color: ''}` blog setting behind dev flag for setting user-defined brand color in themes and emails.
2019-12-17 13:45:31 +03:00
},
Renamed settings keys from default_locale to lang refs #10318 refs https://github.com/TryGhost/Ghost/commit/2614565d5abf1982b61c7ef6e9360f2b9ddb0574 - Renames default_locale settings key as introduced in referenced migration
2020-06-22 13:27:05 +03:00
"lang": {
🎨 rename language to locale and use `en` as default locale (#8490) no issue - this PR references indirecty to https://github.com/TryGhost/Ghost/pull/8437 - i would like to have the settings change already in place before we release the beta - the i18n feature is able to change the locale of Ghost - most i18n libraries use locale - adding/changing settings doesn't require a migration file, but it can make the database a bit messy (because you can end up with default_locale and lang) - furthermore we agreed that the default locale for Ghost should be simply `en`, not `en_US` or `en_GB`
2017-05-31 18:05:49 +03:00
"defaultValue": "en",
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
"validations": {
🔑 Update Validator to 6.2.1 (#7823) no issue Uses new version of [validator](https://github.com/chriso/validator.js) which checks also for in URL embedded script tags.
2017-01-10 15:05:25 +03:00
"isEmpty": false
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
}
},
Renamed settings keys active_timezone to timezone refs https://github.com/TryGhost/Ghost/issues/10318 refs https://github.com/TryGhost/Ghost/commit/2614565d5abf1982b61c7ef6e9360f2b9ddb0574 - Renames to match referenced migration renames - Fixed API responses so they are consistent with newly renamed fields - Not returning lang and timezone keys from settings in API v2 ther rest should be returned in API v3/canary
2020-06-22 14:21:00 +03:00
"timezone": {
Adds UTC as select option to timezones select list no issue - adds '(GMT) UTC' as select option to available Timezones - changes default value for active Timezone to 'Etc/UTC'
2016-06-10 16:05:27 +03:00
"defaultValue": "Etc/UTC",
timezones: Always use the timezone of blog setting closes #6406 - adding timeZone Service to get the offset (=timezone reg. moment-timezone) overall available - new publishedAtOffset date as CP using timeZone service and moment-timezone to calculate offset incl. DST - removing timezone-obj transform as it became obsolete with moment-timezone - reading timezones from configuration/timezones api endpoint - adding a moment-utc transform to only work with utc times in backend - when switching the timezone in the select box, the user will be shown the local time of the selected timezone - added clock service to show actual time ticking below select box - default timezone is '(GMT) Greenwich Mean Time : Dublin, Edinburgh, London' - if no timezone is saved in the settings yet, the default value will be used - showing local time in 'Publish Date' when it's a draft and no actual publishedAt value exists - Removed the format 'DD MMM YY @ HH:mm (UTC Z)' which resolves to '01 Jan 16 @ 14:00 (UTC +02:00)' - Changing the date.js helper in core/server for moment-timezone - Fix timezone select: updates `selectedTimezone` to return the matching object from `availableTimezones` - Including timezones in test for date-helper - update to moment-timezone 0.5.1 - moving form-group of 'selectTimezone' further up so - Tests: - Set except for clock service in test env - adding fixtures to mirage - adding 'service.ajax' to navigation-test.js - adding 'service:ghostPaths' to navigation-test.js - Code improvements - Changing clockservice to ES6
2016-02-02 10:04:40 +03:00
"validations": {
improvement: validate timezones (#7143) no issue - add isTimezone to schema validation
2016-07-26 12:23:20 +03:00
"isTimezone": true,
🔑 Update Validator to 6.2.1 (#7823) no issue Uses new version of [validator](https://github.com/chriso/validator.js) which checks also for in URL embedded script tags.
2017-01-10 15:05:25 +03:00
"isEmpty": false
timezones: Always use the timezone of blog setting closes #6406 - adding timeZone Service to get the offset (=timezone reg. moment-timezone) overall available - new publishedAtOffset date as CP using timeZone service and moment-timezone to calculate offset incl. DST - removing timezone-obj transform as it became obsolete with moment-timezone - reading timezones from configuration/timezones api endpoint - adding a moment-utc transform to only work with utc times in backend - when switching the timezone in the select box, the user will be shown the local time of the selected timezone - added clock service to show actual time ticking below select box - default timezone is '(GMT) Greenwich Mean Time : Dublin, Edinburgh, London' - if no timezone is saved in the settings yet, the default value will be used - showing local time in 'Publish Date' when it's a draft and no actual publishedAt value exists - Removed the format 'DD MMM YY @ HH:mm (UTC Z)' which resolves to '01 Jan 16 @ 14:00 (UTC +02:00)' - Changing the date.js helper in core/server for moment-timezone - Fix timezone select: updates `selectedTimezone` to return the matching object from `availableTimezones` - Including timezones in test for date-helper - update to moment-timezone 0.5.1 - moving form-group of 'selectTimezone' further up so - Tests: - Set except for clock service in test env - adding fixtures to mirage - adding 'service.ajax' to navigation-test.js - adding 'service:ghostPaths' to navigation-test.js - Code improvements - Changing clockservice to ES6
2016-02-02 10:04:40 +03:00
}
},
Renamed ghost_head/ghost_foot to codeinjection_head/codeinjection_foot refs #10318 refs https://github.com/TryGhost/Ghost/commit/2614565d5abf1982b61c7ef6e9360f2b9ddb0574 - Renamed ghost_head/ghost_foot in settings to match the new names introduced in migrations - Above change lead to reshufling in the mappings in input/output serializers - Makes sure change is compatible with v2 API
2020-06-23 14:39:05 +03:00
"codeinjection_head": {
adds code injection admin frontend implementation, handlebar helpers + settings escaping handlebars
2014-07-31 23:36:20 +04:00
"defaultValue" : ""
},
Renamed ghost_head/ghost_foot to codeinjection_head/codeinjection_foot refs #10318 refs https://github.com/TryGhost/Ghost/commit/2614565d5abf1982b61c7ef6e9360f2b9ddb0574 - Renamed ghost_head/ghost_foot in settings to match the new names introduced in migrations - Above change lead to reshufling in the mappings in input/output serializers - Makes sure change is compatible with v2 API
2020-06-23 14:39:05 +03:00
"codeinjection_foot": {
adds code injection admin frontend implementation, handlebar helpers + settings escaping handlebars
2014-07-31 23:36:20 +04:00
"defaultValue" : ""
Start of labs issue #4409
2014-12-14 20:56:04 +03:00
},
Structured Data 3.0 closes #6534 - new input fields in general settings incl. validation - facebook and twitter as new models in settings.js - adds values for facebook and twitter to default-settings.js - adds blog helpers for facebook and twittter - rather than saving the whole URL, the Twitter username incl. '@' will be extracted from URL and saved in the settings. The User will still input the full URL. After saving the blog setting, the stored Twitter username will be parsed again as the full URL and available in the input field. A custom transform is used for this. - adding meta fields to be rendered in {{ghost_head}}: - '<meta property="article:publisher" content="https://www.facebook.com/page" />' and - '<meta name="twitter:site" content="@user"/>' - adds facebook and twitter to unit test for structured data - adds unit test for general settings - adds acceptance test for new input fields in general settings - adds a custom transform for twitter model to save only the username to the server - adds unit test for transform
2016-03-03 11:52:27 +03:00
"facebook": {
🎨 Changed fixture data and default settings (#9778) closes #9774, refs #9742 - added new fixture posts for Ghost 2.0 - added migration file to remove old fixture posts - only remove them if they are owned by the Ghost author and if they are tagged with getting-started - added new fixture posts if you had all (!) old fixture posts - ensure on rollback we remove the new fixture posts again - updated default settings
2018-08-10 14:55:03 +03:00
"defaultValue" : "ghost"
Structured Data 3.0 closes #6534 - new input fields in general settings incl. validation - facebook and twitter as new models in settings.js - adds values for facebook and twitter to default-settings.js - adds blog helpers for facebook and twittter - rather than saving the whole URL, the Twitter username incl. '@' will be extracted from URL and saved in the settings. The User will still input the full URL. After saving the blog setting, the stored Twitter username will be parsed again as the full URL and available in the input field. A custom transform is used for this. - adding meta fields to be rendered in {{ghost_head}}: - '<meta property="article:publisher" content="https://www.facebook.com/page" />' and - '<meta name="twitter:site" content="@user"/>' - adds facebook and twitter to unit test for structured data - adds unit test for general settings - adds acceptance test for new input fields in general settings - adds a custom transform for twitter model to save only the username to the server - adds unit test for transform
2016-03-03 11:52:27 +03:00
},
"twitter": {
🎨 Changed fixture data and default settings (#9778) closes #9774, refs #9742 - added new fixture posts for Ghost 2.0 - added migration file to remove old fixture posts - only remove them if they are owned by the Ghost author and if they are tagged with getting-started - added new fixture posts if you had all (!) old fixture posts - ensure on rollback we remove the new fixture posts again - updated default settings
2018-08-10 14:55:03 +03:00
"defaultValue" : "tryghost"
Structured Data 3.0 closes #6534 - new input fields in general settings incl. validation - facebook and twitter as new models in settings.js - adds values for facebook and twitter to default-settings.js - adds blog helpers for facebook and twittter - rather than saving the whole URL, the Twitter username incl. '@' will be extracted from URL and saved in the settings. The User will still input the full URL. After saving the blog setting, the stored Twitter username will be parsed again as the full URL and available in the input field. A custom transform is used for this. - adding meta fields to be rendered in {{ghost_head}}: - '<meta property="article:publisher" content="https://www.facebook.com/page" />' and - '<meta name="twitter:site" content="@user"/>' - adds facebook and twitter to unit test for structured data - adds unit test for general settings - adds acceptance test for new input fields in general settings - adds a custom transform for twitter model to save only the username to the server - adds unit test for transform
2016-03-03 11:52:27 +03:00
},
Navigation UI Ember Integration Closes #4537 - Adds Navigation to the Settings menu - Adds a `navigationUI` config flag (redirects if not an editor or author)
2015-01-11 22:55:52 +03:00
"navigation": {
Updated links to docs (#10941) no issue
2019-07-22 13:17:50 +03:00
"defaultValue": "[{\"label\":\"Home\", \"url\":\"/\"},{\"label\":\"Tag\", \"url\":\"/tag/getting-started/\"}, {\"label\":\"Author\", \"url\":\"/author/ghost/\"},{\"label\":\"Help\", \"url\":\"https://ghost.org/docs/\"}]"
Slack integration closes #6584 - Frontend Changes: - adds 'Apps' to Navigation Menu - adds 'Slack' as nested page to Apps - adds `apps.css` - adds `slack-integration` model and uses `slack-settings` custom transform to parse JSON file - adds validation for `slack` model - adds fixtures and `slack/test` API endpoint to Mirage - adds acceptance tests for `apps-test` and `slack-test` - adds unit tests for `slack-settings` and `slack-integration` - Backend Changes: - adds API endpoint `slack/test` to send Test Notification - adds default-values for slack model - sends payload to slack: - text: the url of the blogpost / test message - icon_url: url to ghost logo - username: Ghost - adds `slack/index.js` to send webhook to slack if - a new post is published (if slack webhook url is saved in settings) - user clicks on 'Send Test Notification' in UI - adds `slack.init()` to `server.index.js` to add event listener - adds unit test for `slack/index`
2016-03-29 11:40:44 +03:00
},
✨ Added support for secondary navigation (#11409) no issue - Secondary navigation means most nav concepts are supported, e.g. header & footer, or left & right - The UI is added separately, this PR adds supporting concepts: - make sure the default value is an empty array - add support in the API (v3 only) - add handling in the navigation helper
2019-12-04 07:12:02 +03:00
"secondary_navigation": {
"defaultValue": "[]"
},
Added global site SEO fields in Admin API (#10923) refs #10921 - New SEO related fields will now be available as a part of Admin API /settings endpoint - The ordering of fields is taken from post's schema - Extended settings test suite with new SEO fields - Adjusted settings model unit test
2019-07-18 17:24:34 +03:00
"meta_title": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 300
}
}
},
"meta_description": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 500
}
}
},
"og_image": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 2000
}
}
},
"og_title": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 300
}
}
},
"og_description": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 300
}
}
},
"twitter_image": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 2000
}
}
},
"twitter_title": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 300
}
}
},
"twitter_description": {
"defaultValue": null,
"validations": {
"isLength": {
"max": 300
}
}
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
}
},
Updating settings types - issue #573, issue #632
2013-09-14 22:04:41 +04:00
"theme": {
🎨 settings inconsistency (#8381) no issue - replace camelCase settings keys with underscore_case for consistency - discussed here https://github.com/TryGhost/Ghost-Admin/pull/661#discussion_r112939982
2017-04-24 20:41:00 +03:00
"active_theme": {
Added migration to populate settings.{group,flags} (#11954) refs https://github.com/TryGhost/Ghost/issues/10318 - maps old `settings.type` values to new `settings.type/group` values - uses an explicit map so that we don't lose information and can safely roll back even though we're modifying `settings.type` too - updates `settings.type` values too to keep code working while we switch to using `settings.group` - sets the `settings.group` value for all settings which are keeping the same group as their current type - adapts `settings.type` validations to match new groups - adds flags to specific settings, both in the migration for existing settings records and in default-settings.json for new settings records
2020-06-24 14:38:18 +03:00
"defaultValue": "casper",
"flags": "RO"
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
}
},
Change type for private blog settings refs #5614 and #5503 - update private blog type, including update to settings.edit - switch order of populate settings & update fixtures + populate all settings Private blog settings should not be returned by public endpoints therefore they need a type which is not `blog` or `theme`. `core` doesn't suit either, as those settings don't usually have UI To resolve this, I created a new type `private` which can be used for any setting which has a UI but should not be public data
2015-08-24 14:43:26 +03:00
"private": {
🎨 settings inconsistency (#8381) no issue - replace camelCase settings keys with underscore_case for consistency - discussed here https://github.com/TryGhost/Ghost-Admin/pull/661#discussion_r112939982
2017-04-24 20:41:00 +03:00
"is_private": {
Updated settings validations refs #10582 - the db input formatter ensures we always forward "true" or "false" for boolean fields
2019-03-07 14:23:57 +03:00
"defaultValue": "false",
"validations": {
"isIn": [["true", "false"]]
}
Change type for private blog settings refs #5614 and #5503 - update private blog type, including update to settings.edit - switch order of populate settings & update fixtures + populate all settings Private blog settings should not be returned by public endpoints therefore they need a type which is not `blog` or `theme`. `core` doesn't suit either, as those settings don't usually have UI To resolve this, I created a new type `private` which can be used for any setting which has a UI but should not be public data
2015-08-24 14:43:26 +03:00
},
"password": {
"defaultValue": ""
✨ Private RSS feed (#9088) refs #9001 When a blog is in private mode there is now an unguessable URL that allows access to the RSS feed for internal use, commenting systems, etc. - add public hash for private blogging - auto generate on bootstrap if missing - global hash, we can re-use in the future - update private blogging middleware to detect the private RSS URL and rewrite it so that the normal rss route/code is used for display - if a normal `/rss/` route is accessed with a private session return a 404
2017-10-05 13:07:32 +03:00
},
"public_hash": {
"defaultValue": null
Change type for private blog settings refs #5614 and #5503 - update private blog type, including update to settings.edit - switch order of populate settings & update fixtures + populate all settings Private blog settings should not be returned by public endpoints therefore they need a type which is not `blog` or `theme`. `core` doesn't suit either, as those settings don't usually have UI To resolve this, I created a new type `private` which can be used for any setting which has a UI but should not be public data
2015-08-24 14:43:26 +03:00
}
Added members related db changes and models refs #10213
2018-12-10 12:20:54 +03:00
},
"members": {
Improve visibility's default handling (#11183) no issue - Moved default_content_visibility out of labs as we should be extra careful with what is exposed in the labs + it doesn't really belong there.
2019-10-02 12:08:10 +03:00
"default_content_visibility": {
"defaultValue": "public"
},
Cleaned up members & stripe settings (#11957) * Updated members default settings ref #10318 This pulls out the members_subscription_settings & stripe_connect_intgration settings into separate keys * Updated usage of members_from_address * Updated stripe_connect usage * Updated members config to use new settings * Updated members middleware to use isStripeConnected * Updated members service to reload correctly We reload the members-api instance when the related settings change, so this makes sure we're listening to the correct settings changes * Updated ghost_head helper to use new settings * Updated theme middleware to use new settings * Renamed members_allow_signup -> members_allow_free_signup * Fixed tests after settings refactor * Removed from direct key settings key * Fixed regression tests for settings api
2020-06-29 17:22:42 +03:00
"members_allow_free_signup": {
Fixed members default-settings default values refs #10318
2020-06-29 20:34:14 +03:00
"defaultValue": "true"
Added stripe_connect_integration default setting no-issue This will be used to store the keys and other information after a sucessful Stripe Connect OAuth flow.
2020-05-28 13:40:49 +03:00
},
Cleaned up members & stripe settings (#11957) * Updated members default settings ref #10318 This pulls out the members_subscription_settings & stripe_connect_intgration settings into separate keys * Updated usage of members_from_address * Updated stripe_connect usage * Updated members config to use new settings * Updated members middleware to use isStripeConnected * Updated members service to reload correctly We reload the members-api instance when the related settings change, so this makes sure we're listening to the correct settings changes * Updated ghost_head helper to use new settings * Updated theme middleware to use new settings * Renamed members_allow_signup -> members_allow_free_signup * Fixed tests after settings refactor * Removed from direct key settings key * Fixed regression tests for settings api
2020-06-29 17:22:42 +03:00
"members_from_address": {
Added RO flag to members_from_address refs #10318 This was incorrectly missing before
2020-06-30 14:26:27 +03:00
"defaultValue": "noreply",
"flags": "RO"
Cleaned up members & stripe settings (#11957) * Updated members default settings ref #10318 This pulls out the members_subscription_settings & stripe_connect_intgration settings into separate keys * Updated usage of members_from_address * Updated stripe_connect usage * Updated members config to use new settings * Updated members middleware to use isStripeConnected * Updated members service to reload correctly We reload the members-api instance when the related settings change, so this makes sure we're listening to the correct settings changes * Updated ghost_head helper to use new settings * Updated theme middleware to use new settings * Renamed members_allow_signup -> members_allow_free_signup * Fixed tests after settings refactor * Removed from direct key settings key * Fixed regression tests for settings api
2020-06-29 17:22:42 +03:00
},
"stripe_product_name": {
"defaultValue": "Ghost Subscription"
},
"stripe_secret_key": {
"defaultValue": null
},
"stripe_publishable_key": {
"defaultValue": null
},
"stripe_plans": {
Fixed stripe_plans default settings refs #10318 These should be fractional amounts so they needed to be 100x larger
2020-06-29 17:44:50 +03:00
"defaultValue": "[{\"name\":\"Monthly\",\"currency\":\"usd\",\"interval\":\"month\",\"amount\":500},{\"name\":\"Yearly\",\"currency\":\"usd\",\"interval\":\"year\",\"amount\":5000}]"
Cleaned up members & stripe settings (#11957) * Updated members default settings ref #10318 This pulls out the members_subscription_settings & stripe_connect_intgration settings into separate keys * Updated usage of members_from_address * Updated stripe_connect usage * Updated members config to use new settings * Updated members middleware to use isStripeConnected * Updated members service to reload correctly We reload the members-api instance when the related settings change, so this makes sure we're listening to the correct settings changes * Updated ghost_head helper to use new settings * Updated theme middleware to use new settings * Renamed members_allow_signup -> members_allow_free_signup * Fixed tests after settings refactor * Removed from direct key settings key * Fixed regression tests for settings api
2020-06-29 17:22:42 +03:00
},
"stripe_connect_publishable_key": {
"defaultValue": null
},
"stripe_connect_secret_key": {
"defaultValue": null
},
"stripe_connect_livemode": {
"defaultValue": null
},
"stripe_connect_display_name": {
"defaultValue": null
},
"stripe_connect_account_id": {
"defaultValue": null
Added new top-level bulk email settings no issue
2019-11-13 06:48:26 +03:00
}
},
Added new settings for members modal no issue - reverts commit 87c31444fd41d182f3add55f72e0e0fb9cdcc1ff but with modifications to settings naming - Adds new settings for members modal customization to default settings - `portal_button` controls the visibility of beacon in members modal - `portal_name` controls the visibility of name field in signup - `portal_plans` controls the visibility of plans allowed for member to signup with - Adds stripe connect check to determine if stripe is setup or not - Adds the 3 new settings to members site data - Updates to snake case naming for members site API data
2020-06-19 17:04:40 +03:00
"portal" : {
"portal_name": {
"defaultValue": "true",
"validations": {
"isEmpty": false,
"isIn": [["true", "false"]]
}
},
"portal_button": {
"defaultValue": "true",
"validations": {
"isEmpty": false,
"isIn": [["true", "false"]]
}
},
"portal_plans": {
"defaultValue": "[\"free\", \"monthly\", \"yearly\"]"
}
},
Organised default settings into new groups (#11952) refs https://github.com/TryGhost/Ghost/issues/10318 - precursor to migrating from `settings.type` to `settings.group` - renames `blog` type to `site` - renames `bulk_email` type to `email` - moves settings out of `site` (previously `blog`) into more appropriate groups such as `core` or individual feature groups
2020-06-23 22:49:08 +03:00
"email": {
Added new top-level bulk email settings no issue
2019-11-13 06:48:26 +03:00
"bulk_email_settings": {
"defaultValue": "{\"provider\":\"mailgun\", \"apiKey\": \"\", \"domain\": \"\", \"baseUrl\": \"\"}"
Added members related db changes and models refs #10213
2018-12-10 12:20:54 +03:00
}
Organised default settings into new groups (#11952) refs https://github.com/TryGhost/Ghost/issues/10318 - precursor to migrating from `settings.type` to `settings.group` - renames `blog` type to `site` - renames `bulk_email` type to `email` - moves settings out of `site` (previously `blog`) into more appropriate groups such as `core` or individual feature groups
2020-06-23 22:49:08 +03:00
},
"amp": {
"amp": {
"defaultValue" : "true",
"validations": {
"isIn": [["true", "false"]]
}
}
},
"labs": {
"labs": {
"defaultValue": "{}"
}
},
"slack": {
"slack": {
"defaultValue": "[{\"url\":\"\", \"username\":\"Ghost\"}]"
}
},
"unsplash": {
"unsplash": {
"defaultValue": "{\"isActive\": true}"
}
},
"views": {
"shared_views": {
Fixed defaultValue for sharedViews setting refs https://github.com/TryGhost/Ghost/issues/10318 - `shared_views` is always an array (Ghost-Admin has handling to revert it to an array if it's anything else) but it's default value was set to an empty object
2020-06-24 17:15:55 +03:00
"defaultValue": "[]"
Organised default settings into new groups (#11952) refs https://github.com/TryGhost/Ghost/issues/10318 - precursor to migrating from `settings.type` to `settings.group` - renames `blog` type to `site` - renames `bulk_email` type to `email` - moves settings out of `site` (previously `blog`) into more appropriate groups such as `core` or individual feature groups
2020-06-23 22:49:08 +03:00
}
Proper settings infrastructure, allowing new features without compromising old data. On server load, check for settings which have not been set, and apply a default value to the settings table from a JSON file.
2013-09-02 05:49:08 +04:00
}
Restructure default-settings.json and add validations to important settings.
2013-09-02 05:49:08 +04:00
}
Reference in New Issue Copy Permalink