mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-22 18:31:57 +03:00

History

Daniel Lockyer 85098e07d4 Configured all unit tests to use dot reporter refs https://ghost.slack.com/archives/C02G9E68C/p1696490748701419 - this configures mocha to use the dot reporter because the default is way too verbose in CI		2023-10-05 12:24:24 +02:00
..
lib	Upgraded to latest version of @tryghost/request	2023-09-26 12:45:14 +01:00
test	Upgraded to latest version of @tryghost/request	2023-09-26 12:45:14 +01:00
.eslintrc.js	Added update check service initial commit	2021-06-02 18:17:56 +04:00
package.json	Configured all unit tests to use dot reporter	2023-10-05 12:24:24 +02:00
README.md	Tidied up package README and LICENSE files	2022-07-26 15:22:10 +02:00

README.md

Update Check Service

Makes a request to updates.ghost.org to check for release & custom notifications. The service is provided in return for users opting in to anonymous usage data collection.

Usage

Check the UpdateCheckService's constructor JSDoc for the list of available parameters. This is how the service is initialized in Ghost:

const api = require('./api').v2;
const GhostMailer = require('./services/mail').GhostMailer;
const config = require('../shared/config');
const urlUtils = require('./../shared/url-utils');

const i18n = require('../shared/i18n');
const logging = require('../shared/logging');
const request = require('./lib/request');
const ghostVersion = require('./lib/ghost-version');
const UpdateCheckService = require('@tryghost/update-check-service');

const updateChecker = new UpdateCheckService({
    api: {
        settings: {
            read: api.settings.read,
            edit: api.settings.edit
        },
        posts: {
            browse: api.posts.browse
        },
        users: {
            browse: api.users.browse
        },
        notifications: {
            add: api.notifications.add
        }
    },
    config: {
        mail: config.get('mail'),
        env: config.get('env'),
        databaseType: config.get('database').client,
        checkEndpoint: config.get('updateCheck:url'),
        isPrivacyDisabled: config.isPrivacyDisabled('useUpdateCheck'),
        notificationGroups: config.get('notificationGroups'),
        siteUrl: urlUtils.urlFor('home', true),
        forceUpdate: config.get('updateCheck:forceUpdate'),
        ghostVersion: ghostVersion.original
    },
    i18n,
    logging,
    request,
    sendEmail: ghostMailer.send
});

// run the update check with 

updateChecker.check();