https://github.com/studentiunimi/overleaf-registration

Public user registration handler for a self-hosted Overleaf instance
https://github.com/studentiunimi/overleaf-registration

overleaf

Last synced: 6 days ago
JSON representation

Public user registration handler for a self-hosted Overleaf instance

• Host: GitHub
• URL: https://github.com/studentiunimi/overleaf-registration
• Owner: StudentiUniMi
• License: mit
• Created: 2022-02-21T17:32:58.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T17:23:13.000Z (3 months ago)
• Last Synced: 2024-11-07T14:08:42.368Z (about 2 months ago)
• Topics: overleaf
• Language: HTML
• Homepage: https://overleaf.studentiunimi.it/register
• Size: 405 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Overleaf registration worker

Public user registration for a self-hosted 

[Overleaf](https://github.com/overleaf/overleaf) instance.

### Why?

We are planning to offer a public Overleaf instance to our users (students and teachers), 

but the Community Edition does not support autonomous user registration: only the site

administrator can create users via the admin panel.

This limitation is unacceptable for our use case, so we implemented it ourselves.

### How?

A simple form (available on `/register` path) is offered to the user asking for its email; 

the application then logs into the Overleaf instance with the administrator account

and sends a request to create a user. 

The user can now create an account by clicking the confirmation link on its mailbox.

## Deployment

There is a Docker image available on 

[ghcr.io/studentiunimi/overleaf-registration](https://ghcr.io/studentiunimi/overleaf-registration),

automatically built by GitHub Actions.

You can check the example `docker-compose.yml` file and tweak it with your configuration.

### Environment variables

The Docker container needs all the following environment variables to function properly:

| Environment variable | Description                                          |

|----------------------|------------------------------------------------------|

| `CAPTCHA_SERVER_KEY` | reCAPTCHA v2 server key                              |

| `CAPTCHA_CLIENT_KEY` | reCAPTCHA v2 client key                              |

| `OL_INSTANCE`        | Overleaf self-hosted instance (without trailing `/`) |

| `OL_ADMIN_EMAIL`     | Overleaf administrator account email                 |

| `OL_ADMIN_PASSWORD`  | Overleaf administrator account password              |