Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cosmetic changes on Readme.md #44

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ npm-debug.log
.buildpath
.project
.idea
*.out
*.out
41 changes: 24 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.<br />
For this, in *properties/esup.json*, uncomment *transport_regexes.mail*, and modify the associated regex.<br />
Expand All @@ -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

Expand All @@ -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
Expand All @@ -58,11 +69,7 @@ Restart=on-failure
WantedBy=multi-user.target
```

### Development


License
----
## License

MIT
[EsupPortail]: <https://www.esup-portail.org/>