diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..fcd8815 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,14 @@ +name: ci checks + +on: + pull_request: + workflow_dispatch: + +jobs: + required-check: + runs-on: ubuntu-24.04 + steps: + - run: | + #TODO : we should add some real checks at some point. Maybe fire up overleaf and confirm it works? + echo "passing" + diff --git a/README.md b/README.md index 9a69076..b64b08e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,43 @@ # latex-presentations Tooling for using LaTeX to create posters and presentations along with public examples of lab automation presentations -Set up overleaf -#. Clone the repo `git clone https://github.com/overleaf/toolkit.git overleaf` -#. remove the git configuration so we can just commit those files: `rm -rf overleaf/.git` -#. Set up basic config `sh overleaf/bin/init`. that's gonna use the full sharelatex image...if you want to make a custom one, put a Dockerfile in there and look at the overleaf.rc -#. Change the `OVERLEAF_LISTEN_IP` and `NGINX_HTTP_LISTEN_IP` to `0.0.0.0` -#. in the overleaf/.gitignore file, comment out `config/**/*` so config will be saved -#. Note: file persistence isn't set up (not sure how to do that), so make sure to save your overleaf projects to zip file frequently. ...or maybe it is now that the data paths in the rc file have been updated...? unclear - -Running overleaf -#. If on Windows, launch a new Ubuntu WSL terminal in VS Code, then `./overleaf/bin/up` (you may need to start Docker Desktop first) -#. Go to http://localhost/launchpad - - -Converting Beamer PDFs to PPTX -#. Based on https://github.com/ashafaei/pdf2pptx -#. Clone the repo `git clone https://github.com/ashafaei/pdf2pptx pdf2pptx` -#. remove the git configuration so we can just commit those files: `rm -rf pdf2pptx/.git` -#. Need to install imagemagick (this version worked, but no particular reason to pin to that): `sudo apt-get update && sudo apt-get install -y imagemagick=8:6.9.12.98+dfsg1-5.2build2` -#. May also need to install zip (this version worked, but no particular reason to pin to that): `sudo apt-get update && sudo apt-get install -y zip=3.0-13ubuntu0.2` -#. Tweak the resolution if you want inside pdf2pptx.sh (this has it ) -#. Run it `bash ./pdf2pptx/pdf2pptx.sh slas.pdf` (at high resolution and for a long presentation, this could take 3-4 minutes. you can watch for progress in the yourfilename.pdf.temp folder it creates if you're nervous) +# First-time setup of Overleaf or updating Overleaf versions + +If you are simply looking to start overleaf from this repo skip to [Running Overleaf](#running-overleaf). + +1. Run the following to clone the repo at a given version, cleanup .git dirs and setup basic config `bash overleaf/bin/init`. that's gonna use the full sharelatex image...if you want to make a custom one, put a Dockerfile in there and look at the overleaf.rc + +```bash +git clone https://github.com/overleaf/toolkit.git overleaf +cd overleaf +git checkout 9280a93c4757e8d8b32e2228c66cc46fc7b835ae # v6.1.2 +cd .. +rm -rf overleaf/.git overleaf/.github +bash overleaf/bin/init +``` + +2. Change the `OVERLEAF_LISTEN_IP` and `NGINX_HTTP_LISTEN_IP` to `0.0.0.0` in overleaf.rc +3. in the overleaf/.gitignore file, comment out `config/**/*` so config will be saved + +> [!NOTE] +> File persistence isn't set up (not sure how to do that), so make sure to save your overleaf projects to zip file frequently. ...or maybe it is now that the data paths in the rc file have been updated...? unclear + +# Running overleaf + +1. If on Windows, launch a new Ubuntu WSL terminal in VS Code, then `./overleaf/bin/up` (you may need to start Docker Desktop first) +2. Go to http://localhost/launchpad +3. Create a new admin user and log in +4. Go to http://localhost +5. Create a new project or work on an existing one + +# How-tos + +## Converting Beamer PDFs to PPTX + +1. Based on https://github.com/ashafaei/pdf2pptx +2. Clone the repo `git clone https://github.com/ashafaei/pdf2pptx pdf2pptx` +3. remove the git configuration so we can just commit those files: `rm -rf pdf2pptx/.git` +4. Need to install imagemagick (this version worked, but no particular reason to pin to that): `sudo apt-get update && sudo apt-get install -y imagemagick=8:6.9.12.98+dfsg1-5.2build2` +5. May also need to install zip (this version worked, but no particular reason to pin to that): `sudo apt-get update && sudo apt-get install -y zip=3.0-13ubuntu0.2` +6. Tweak the resolution if you want inside pdf2pptx.sh (this has it ) +7. Run it `bash ./pdf2pptx/pdf2pptx.sh slas.pdf` (at high resolution and for a long presentation, this could take 3-4 minutes. you can watch for progress in the yourfilename.pdf.temp folder it creates if you're nervous) diff --git a/overleaf/.gitignore b/overleaf/.gitignore index 68d8100..5df16ba 100644 --- a/overleaf/.gitignore +++ b/overleaf/.gitignore @@ -4,7 +4,7 @@ tmp/ *.swp -# config/**/* +#config/**/* !config/.gitkeep data/**/* diff --git a/overleaf/CHANGELOG.md b/overleaf/CHANGELOG.md index 65e2c64..1951dd2 100644 --- a/overleaf/CHANGELOG.md +++ b/overleaf/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 2026-02-19 +### Added +- Updated default [`version`](https://github.com/overleaf/toolkit/blob/master/lib/config-seed/version) to `6.1.2`. + ## 2026-02-02 ### Added - Updated default [`version`](https://github.com/overleaf/toolkit/blob/master/lib/config-seed/version) to `6.1.1`. diff --git a/overleaf/bin/backup-config b/overleaf/bin/backup-config old mode 100644 new mode 100755 diff --git a/overleaf/bin/dev/lint b/overleaf/bin/dev/lint old mode 100644 new mode 100755 diff --git a/overleaf/bin/docker-compose b/overleaf/bin/docker-compose old mode 100644 new mode 100755 diff --git a/overleaf/bin/doctor b/overleaf/bin/doctor old mode 100644 new mode 100755 diff --git a/overleaf/bin/error-logs b/overleaf/bin/error-logs old mode 100644 new mode 100755 diff --git a/overleaf/bin/images b/overleaf/bin/images old mode 100644 new mode 100755 diff --git a/overleaf/bin/init b/overleaf/bin/init old mode 100644 new mode 100755 diff --git a/overleaf/bin/logs b/overleaf/bin/logs old mode 100644 new mode 100755 diff --git a/overleaf/bin/mongo b/overleaf/bin/mongo old mode 100644 new mode 100755 diff --git a/overleaf/bin/rename-env-vars-5-0 b/overleaf/bin/rename-env-vars-5-0 old mode 100644 new mode 100755 diff --git a/overleaf/bin/rename-rc-vars b/overleaf/bin/rename-rc-vars old mode 100644 new mode 100755 diff --git a/overleaf/bin/run-script b/overleaf/bin/run-script old mode 100644 new mode 100755 diff --git a/overleaf/bin/shell b/overleaf/bin/shell old mode 100644 new mode 100755 diff --git a/overleaf/bin/start b/overleaf/bin/start old mode 100644 new mode 100755 diff --git a/overleaf/bin/stop b/overleaf/bin/stop old mode 100644 new mode 100755 diff --git a/overleaf/bin/up b/overleaf/bin/up old mode 100644 new mode 100755 diff --git a/overleaf/bin/upgrade b/overleaf/bin/upgrade old mode 100644 new mode 100755 diff --git a/overleaf/config/overleaf.rc b/overleaf/config/overleaf.rc index 4c0dd17..4cbbe3a 100644 --- a/overleaf/config/overleaf.rc +++ b/overleaf/config/overleaf.rc @@ -5,7 +5,7 @@ PROJECT_NAME=overleaf # Sharelatex container # Uncomment the OVERLEAF_IMAGE_NAME variable to use a user-defined image. # OVERLEAF_IMAGE_NAME=sharelatex/sharelatex -OVERLEAF_DATA_PATH=/home/labsync/overleaf-data/overleaf +OVERLEAF_DATA_PATH=data/overleaf SERVER_PRO=false OVERLEAF_LISTEN_IP=0.0.0.0 OVERLEAF_PORT=80 @@ -16,19 +16,19 @@ DOCKER_SOCKET_PATH=/var/run/docker.sock # Mongo configuration MONGO_ENABLED=true -MONGO_DATA_PATH=/home/labsync/overleaf-data/mongo +MONGO_DATA_PATH=data/mongo MONGO_IMAGE=mongo MONGO_VERSION=8.0 # Redis configuration REDIS_ENABLED=true -REDIS_DATA_PATH=/home/labsync/overleaf-data/redis +REDIS_DATA_PATH=data/redis REDIS_IMAGE=redis:7.4 REDIS_AOF_PERSISTENCE=true # Git-bridge configuration (Server Pro only) GIT_BRIDGE_ENABLED=false -GIT_BRIDGE_DATA_PATH=/home/labsync/overleaf-data/git-bridge +GIT_BRIDGE_DATA_PATH=data/git-bridge # TLS proxy configuration (optional) # See documentation in doc/tls-proxy.md diff --git a/overleaf/config/variables.env b/overleaf/config/variables.env index c1dc28d..2e7aded 100644 --- a/overleaf/config/variables.env +++ b/overleaf/config/variables.env @@ -2,7 +2,7 @@ OVERLEAF_APP_NAME="Our Overleaf Instance" ENABLED_LINKED_FILE_TYPES=project_file,project_output_file -# Enables Thumbnail generation using ImageMagick +# Enables Thumbnail generation using an external converter (pdftocairo by default) ENABLE_CONVERSIONS=true # Disables email confirmation requirement diff --git a/overleaf/config/version b/overleaf/config/version index f3b5af3..5e32542 100644 --- a/overleaf/config/version +++ b/overleaf/config/version @@ -1 +1 @@ -6.1.1 +6.1.2 diff --git a/overleaf/lib/config-seed/variables.env b/overleaf/lib/config-seed/variables.env index c1dc28d..2e7aded 100644 --- a/overleaf/lib/config-seed/variables.env +++ b/overleaf/lib/config-seed/variables.env @@ -2,7 +2,7 @@ OVERLEAF_APP_NAME="Our Overleaf Instance" ENABLED_LINKED_FILE_TYPES=project_file,project_output_file -# Enables Thumbnail generation using ImageMagick +# Enables Thumbnail generation using an external converter (pdftocairo by default) ENABLE_CONVERSIONS=true # Disables email confirmation requirement diff --git a/overleaf/lib/config-seed/version b/overleaf/lib/config-seed/version index f3b5af3..5e32542 100644 --- a/overleaf/lib/config-seed/version +++ b/overleaf/lib/config-seed/version @@ -1 +1 @@ -6.1.1 +6.1.2