-
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create service template for Overleaf * Add README * Add to supported services * Fix bugs * Fix last bug
- Loading branch information
1 parent
3b69c9c
commit 9e931a7
Showing
9 changed files
with
130 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## Overleaf | ||
| Overleaf is a web-based editor to collaborate on LaTex projects. | ||
|
|
||
| ### Setup | ||
| Overleaf is considered as frontend service and can therefore be found in frontends collection, when generating the compose configuration with Compose Generator. | ||
|
|
||
| ### Create Admin user | ||
| To create the admin user, execute the following command on the Docker host system while the containers are running: | ||
| ```sh | ||
| docker exec ${{PROJECT_NAME_CONTAINER}}-frontend-overleaf /bin/bash -c "cd /var/www/sharelatex; grunt user:create-admin --email=<admin-mail>" | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| { | ||
| "label": "Overleaf", | ||
| "preselected": "false", | ||
| "proxied": true, | ||
| "files": [ | ||
| { | ||
| "path": "service.yml", | ||
| "type": "service" | ||
| }, | ||
| { | ||
| "path": "README.md", | ||
| "type": "docs" | ||
| }, | ||
| { | ||
| "path": "environment.env", | ||
| "type": "env" | ||
| } | ||
| ], | ||
| "questions": [ | ||
| { | ||
| "text": "How do you want to call your overleaf instance?", | ||
| "type": 2, | ||
| "defaultValue": "My Overleaf Instance", | ||
| "validator": "required", | ||
| "variable": "OVERLEAF_NAME" | ||
| }, | ||
| { | ||
| "text": "Which email address do you want to set as admin email?", | ||
| "type": 2, | ||
| "validator": "email", | ||
| "variable": "OVERLEAF_ADMIN_EMAIL" | ||
| }, | ||
| { | ||
| "text": "Which SMTP host do you want to use?", | ||
| "type": 2, | ||
| "validator": "required", | ||
| "variable": "OVERLEAF_SMTP_HOST" | ||
| }, | ||
| { | ||
| "text": "Which SMTP port do you want to use?", | ||
| "type": 2, | ||
| "defaultValue": "587", | ||
| "validator": "port", | ||
| "variable": "OVERLEAF_SMTP_PORT" | ||
| }, | ||
| { | ||
| "text": "Which SMTP user do you want to use?", | ||
| "type": 2, | ||
| "validator": "required", | ||
| "variable": "OVERLEAF_SMTP_USER" | ||
| }, | ||
| { | ||
| "text": "Which SMTP password do you want to use?", | ||
| "type": 2, | ||
| "variable": "OVERLEAF_SMTP_PASSWORD" | ||
| }, | ||
| { | ||
| "text": "On which port do you want to expose Overleaf?", | ||
| "type": 2, | ||
| "defaultValue": "80", | ||
| "validator": "port", | ||
| "variable": "OVERLEAF_PORT" | ||
| }, | ||
| { | ||
| "text": "Which version of Overleaf do you want to use?", | ||
| "type": 2, | ||
| "defaultValue": "3.0", | ||
| "variable": "OVERLEAF_VERSION" | ||
| } | ||
| ], | ||
| "volumes": [ | ||
| { | ||
| "text": "Custom path for Overleaf data volume?", | ||
| "defaultValue": "./volumes/overleaf-data", | ||
| "variable": "VOLUME_OVERLEAF_DATA", | ||
| "advanced": true | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| SHARELATEX_APP_NAME='"${{OVERLEAF_NAME}}"' | ||
| SHARELATEX_MONGO_URL=mongodb://${{MONGODB_APPLICATION_USER}}:${{_PW_MONGODB_APPLICATION}}@database-mongodb/${{MONGODB_DATABASE}} | ||
| SHARELATEX_REDIS_HOST=database-redis | ||
| SHARELATEX_REDIS_PASS=${{_PW_REDIS}} | ||
| EMAIL_CONFIRMATION_DISABLED=true | ||
| SHARELATEX_ADMIN_EMAIL=${{OVERLEAF_ADMIN_EMAIL}} | ||
| SHARELATEX_EMAIL_FROM_ADDRESS=${{OVERLEAF_ADMIN_EMAIL}} | ||
| SHARELATEX_EMAIL_SMTP_HOST=${{OVERLEAF_SMTP_HOST}} | ||
| SHARELATEX_EMAIL_SMTP_PORT=${{OVERLEAF_SMTP_PORT}} | ||
| SHARELATEX_EMAIL_SMTP_USER=${{OVERLEAF_SMTP_USER}} | ||
| SHARELATEX_EMAIL_SMTP_PASS=${{OVERLEAF_SMTP_PASSWORD}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| image: sharelatex/sharelatex:${{OVERLEAF_VERSION}} | ||
| container_name: ${{PROJECT_NAME_CONTAINER}}-frontend-overleaf | ||
| restart: always | ||
| networks: | ||
| - overleaf-mongodb | ||
| - overleaf-redis | ||
| ports: | ||
| - ${{OVERLEAF_PORT}}:80 | ||
| volumes: | ||
| - ${{VOLUME_OVERLEAF_DATA}}:/var/lib/sharelatex | ||
| env_file: | ||
| - environment.env |