Git Product home page Git Product logo

app-simple-idprovider's Introduction

Simple ID Provider App for Enonic XP

Build Status License

This ID Provider contains a simple login/logout page to authenticate your local users. (Optional) Provides a password reset mechanism. (Optional) Retrieves and displays the Gravatar picture of a logged in user.

Usage

Step 1: Install the application

  1. In the admin tool "Applications" of your Enonic XP installation, click on "Install".
  2. Select the tab "Enonic Market", find "Simple ID Provider", and click on the link "Install".

Step 2: Create and configure the user store

  1. In the admin tool "Users", click on "New".
  2. Fill in the fields and, for the field "ID Provider", select the application "Simple ID Provider".
  3. Configure the ID Provider:
    • Title: Title used by the login/logout page
    • Theme: Display theme of the login/logout page
    • Gravatar picture: If enabled, the Gravatar picture of the logged in user will be displayed on the logout page
    • (Optional) Forgot password: If set, the login page will propose a password reset mechanism. You need to have set up the mail configuration (See Mail Configuration for more information).
      • Email author: The author of the password reset mail
      • Site name: Name used in the password reset mail body
      • (Optional) ReCaptcha: Add a reCaptcha field to the forgot password form. You need to have registered your website on reCaptcha (See reCaptcha for more information).
        • Site key: Your reCaptcha site key.
        • Secret key: Your reCaptcha secret key.

Step 3: Create and configure the user store

  1. Edit the configuration file "com.enonic.xp.web.vhost.cfg", and set the new user store to your virtual host. (See Virtual Host Configuration for more information).

    enabled=true
      
    mapping.admin.host = localhost
    mapping.admin.source = /admin
    mapping.admin.target = /admin
    mapping.admin.userStore = system
    
    mapping.mysite.host = localhost
    mapping.mysite.source = /
    mapping.mysite.target = /portal/master/mysite
    mapping.mysite.userStore = myuserstore

Releases and Compatibility

App version Required XP version Download
1.0.0 6.6.0 Download
1.1.0 6.7.0 Download
1.1.1 6.7.0 Download
1.1.2 6.7.0 Download

Building and deploying

Build this application from the command line. Go to the root of the project and enter:

./gradlew clean build

To deploy the app, set $XP_HOME environment variable and enter:

./gradlew deploy

Releasing new version

To release a new version of this app, please follow the steps below:

  1. Update version (and possibly xpVersion) in gradle.properties.

  2. Compile and deploy to our Maven repository:

    ./gradlew clean build uploadArchives

  3. Update README.md file with new version information and compatibility.

  4. Tag the source code using git tag command (where X.Y.Z is the released version):

    git tag vX.Y.Z

  5. Push the updated code to GitHub.

    git push origin vX.Y.Z

app-simple-idprovider's People

Contributors

glennricaud avatar rbrastad avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.