History

Daniel Lockyer 7a2f766668 ✨ Added logging configuration option for timestamps to use the local timezone fixes https://github.com/TryGhost/Ghost/issues/15190 refs https://github.com/TryGhost/framework/pull/76 - log output always uses UTC timestamps, but it may be desirable to configure logs to use the local machine timezone - a new config option has been added to `@tryghost/logging` so you can switch the logs to the local timezone - this commit bumps the package and sets the default config option to `false`, so it doesn't suddenly change the timezone of the logs - docs will be updated soon but if you'd like to use the timezone-altered timestamps, you can set `logging.useLocalTime` to `true` - credits to https://github.com/levee223 for the implementation and PR		2022-08-31 10:29:55 +01:00
..
lib
test	Cleaned up unused test utils	2022-08-18 11:55:49 +02:00
.eslintrc.js
package.json	✨ Added logging configuration option for timestamps to use the local timezone	2022-08-31 10:29:55 +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();