diff --git a/.gitignore b/.gitignore index 7d6484d..ab456ee 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,4 @@ npm-debug.log .buildpath .project .idea -*.out \ No newline at end of file +*.out diff --git a/README.md b/README.md index 51dadbc..3edbfec 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # esup-otp-manager -Manager for the esup-otp-api. Allow users to edit theirs preferences and admins to administrate ;) -### Version -1.5 **Require "npm install"** +Manager for the esup-otp-api. Allow users to edit their preferences and admins to administrate ;) + +## Version + +1.5 **Require `npm install`** + - You can now **redirect a manager to a user's page** using a link like `http://localhost:4000/login?user=toto` - You can now **prevent users from using their professional e-mail addresses** to *random_code_mail* transport.
For this, in *properties/esup.json*, uncomment *transport_regexes.mail*, and modify the associated regex.
@@ -11,19 +14,27 @@ For this, in *properties/esup.json*, uncomment *transport_regexes.mail*, and mod - Update dependencies - Some refactors -### Requirements +## Requirements + - [esup-otp-api](https://github.com/EsupPortail/esup-otp-api) -### Installation -- git clone https://github.com/EsupPortail/esup-otp-manager.git -- npm install -- change the fields values in properties/esup.json to your installation, some explanations are in #how_to attributes -- npm start +## Installation + +```sh +# Download esup-otp-manager +git clone https://github.com/EsupPortail/esup-otp-manager.git +# Install required libraries +npm install +# change the fields values in properties/esup.json to your installation, some explanations are in `#how_to` attributes +# Start server +npm start +``` ### Behind Apache -- https -``` +- https + +```apache RequestHeader set X-Forwarded-Proto https RequestHeader set X-Forwarded-Port 443 @@ -41,7 +52,7 @@ ProxyPassReverse http://127.0.0.1:4000/ ### Systemd -``` +```ini [Unit] Description=esup-otp-manager nodejs app Documentation=https://github.com/EsupPortail/esup-otp-manager @@ -58,11 +69,7 @@ Restart=on-failure WantedBy=multi-user.target ``` -### Development - - -License ----- +## License MIT [EsupPortail]: