{"id":18725031,"url":"https://github.com/studentiunimi/overleaf-registration","last_synced_at":"2025-08-24T19:08:34.659Z","repository":{"id":43711734,"uuid":"461966061","full_name":"StudentiUniMi/overleaf-registration","owner":"StudentiUniMi","description":"Public user registration handler for a self-hosted Overleaf instance ","archived":false,"fork":false,"pushed_at":"2024-10-18T17:23:13.000Z","size":415,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-28T13:14:12.680Z","etag":null,"topics":["overleaf"],"latest_commit_sha":null,"homepage":"https://overleaf.studentiunimi.it/register","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StudentiUniMi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-21T17:32:58.000Z","updated_at":"2024-12-05T20:22:31.000Z","dependencies_parsed_at":"2022-08-22T17:11:02.728Z","dependency_job_id":null,"html_url":"https://github.com/StudentiUniMi/overleaf-registration","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudentiUniMi%2Foverleaf-registration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudentiUniMi%2Foverleaf-registration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudentiUniMi%2Foverleaf-registration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudentiUniMi%2Foverleaf-registration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StudentiUniMi","download_url":"https://codeload.github.com/StudentiUniMi/overleaf-registration/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239592988,"owners_count":19664855,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["overleaf"],"created_at":"2024-11-07T14:08:52.661Z","updated_at":"2025-02-19T03:41:33.289Z","avatar_url":"https://github.com/StudentiUniMi.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overleaf registration worker\n\nPublic user registration for a self-hosted \n[Overleaf](https://github.com/overleaf/overleaf) instance.\n\n### Why?\nWe are planning to offer a public Overleaf instance to our users (students and teachers), \nbut the Community Edition does not support autonomous user registration: only the site\nadministrator can create users via the admin panel.\n\nThis limitation is unacceptable for our use case, so we implemented it ourselves.\n\n### How?\nA simple form (available on `/register` path) is offered to the user asking for its email; \nthe application then logs into the Overleaf instance with the administrator account\nand sends a request to create a user. \n\nThe user can now create an account by clicking the confirmation link on its mailbox.\n\n## Deployment\nThere is a Docker image available on \n[ghcr.io/studentiunimi/overleaf-registration](https://ghcr.io/studentiunimi/overleaf-registration),\nautomatically built by GitHub Actions.\nYou can check the example `docker-compose.yml` file and tweak it with your configuration.\n\n### Environment variables\nThe Docker container needs all the following environment variables to function properly:\n\n| Environment variable | Description                                          |\n|----------------------|------------------------------------------------------|\n| `CAPTCHA_SERVER_KEY` | reCAPTCHA v2 server key                              |\n| `CAPTCHA_CLIENT_KEY` | reCAPTCHA v2 client key                              |\n| `OL_INSTANCE`        | Overleaf self-hosted instance (without trailing `/`) |\n| `OL_ADMIN_EMAIL`     | Overleaf administrator account email                 |\n| `OL_ADMIN_PASSWORD`  | Overleaf administrator account password              |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstudentiunimi%2Foverleaf-registration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstudentiunimi%2Foverleaf-registration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstudentiunimi%2Foverleaf-registration/lists"}