mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-24 06:35:49 +03:00

History

Daniel Lockyer 08b786af3b Bumped TryGhost-owned dependencies and lockfile - this was all getting terribly behind so I've done several things: - majority of `@tryghost/*` except Lexical packages - gscan + knex-migrator to remove old `@tryghost/errors` usage - bumped lockfile		2023-01-02 20:55:22 +01:00
..
lib	Removed bluebird from misc packages (#15676 )	2022-10-30 15:16:10 +00:00
test	Cleaned up unused test utils	2022-08-18 11:55:49 +02:00
.eslintrc.js	Added update check service initial commit	2021-06-02 18:17:56 +04:00
package.json	Bumped TryGhost-owned dependencies and lockfile	2023-01-02 20:55:22 +01: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();