Skip to main content
Version: 1.5.0

Upgrade 1.5.0 - 1.6.0

In this version, there is break changes happened because OpenSSO now adding more social logins which is many things are changed in views template and there is some new files added. Just replace it, will be more easier, but if you have already modified OpenSSO code by yourself, then you should consider about these files:

File New
root
├── public/
│   └── assets/
│       └── vendor/
│           └── fontawesome-free-6.6.0-web/*
├── views/
│   └── default/
│       └── user-deletion-policy.html
├── views/
│   └── inverse/
│       └── user-deletion-policy.html
.
File Changes
root
├── routes/
│   ├── oauth.js
│   ├── page.js
│   └── user.js
├── schemas/
│   └── oauth.js
├── views/
│   └── default/
│       ├── backend/
│       │   ├── _global_js_.html
│       │   ├── _header.html
│       │   ├── _layout.html
│       │   ├── _layout_profile.html
│       │   ├── _menu_aside.html
│       │   ├── dashboard.html
│       │   └── my_profile.html
│       ├── _footer.html
│       ├── _global_js.html
│       ├── _header.html
│       ├── _layout.html
│       ├── _navbar.html
│       ├── about.html
│       ├── contact.html
│       ├── sign-in.html
│       └── sso-login.html
├── views/
│   └── inverse/
│       ├── backend/
│       │   ├── _global_js_.html
│       │   ├── _header.html
│       │   ├── _layout.html
│       │   ├── _layout_profile.html
│       │   ├── _menu_aside.html
│       │   ├── dashboard.html
│       │   └── my_profile.html
│       ├── _footer.html
│       ├── _global_js.html
│       ├── _header.html
│       ├── _layout.html
│       ├── _navbar.html
│       ├── about.html
│       ├── contact.html
│       ├── sign-in.html
│       └── sso-login.html
├── changelog.md
├── config.default.js
├── config.js
├── package-lock.json
├── package.json
.

How to manually Upgrade ?​

Please attention, in this upgrade, there is a small break changes. So you need to be careful to follow this upgrade steps.

Always Backup

Please Remember to always backup before doing any upgrades.

Try on local

To increase the successful possibilty when doing upgrading, always try on your local computer first.

1. Modify your config.js​

Add some social logins configuration in your config.js.
Its located after apple.

config.js
{
  // ...
  {
    // ...
    google: {
      // ...
    },
    apple: {
      // ...
    },
    github: {
      enable: false,
      client_id: 'XXXXXXXXXXXX',
      client_secret: 'XXXXXXXXXXXX'
    },
    gitlab: {
      enable: false,
      client_id: 'XXXXXXXXXXXX',
      client_secret: 'XXXXXXXXXXXX'
    },
    facebook: {
      enable: false,
      appId: 'XXXXXXXXXXXX',
      appSecret: 'XXXXXXXXXXXX'
    },
    x: {
      enable: false,
      consumer_api_key: 'XXXXXXXXXXXX',
      consumer_api_secret: 'XXXXXXXXXXXX',
      client_id: 'XXXXXXXXXXXX',
      client_secret: 'XXXXXXXXXXXX'
    },
    entra: {
      enable: false,
      clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
      clientSecret: 'xxxxx~xx~xxxxxxxxxx~x_xxxxxxxxxxxxxxxxx',
      redirectUri: 'https://yourdomain.com/sign-in',
      tenantId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx'
    }
  },
  // ...
}

module.exports = config

2. Replace the old package-lock.json and package.json.​

Just replace it with newer file from this version.

3. Delete current node_modules directory.​

Then run this command
npm install

It will automatically installing the new package and dependencies.

4. Done​

Now you can try to run the OpenSSO application.

node server.js

or

npm start