overleaf / overleaf/toolkit

changes to variables.env (OVERLEAF_NAV_TITLE) not reflected

Open
#295 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
1.3k
Forks
310
Avg merge
3d 12h
Merged PRs (30d)
1

Description

Steps to Reproduce

  1. Setting OVERLEAF_NAV_TITLE="Another title"
    2.Stopping/starting the toolkit with bin/stop ; bin/start

Expected Behaviour

Header should change to "Another title"

Observed Behaviour

Header remains initaally set vale

Context

Makes it unable to change header/logo, etc/ as instructed on https://github.com/overleaf/overleaf/wiki/Configuring-Headers,-Footers-&-Logo

Technical Info

  • URL: any url
  • Browser Name and version: any browser / Overleaf 5.1.1.
  • Operating System and version (desktop or mobile): windos / linux
  • Signed in as: adminaccount but also without logging in
  • Project and/or file: variables.env

Analysis

Changing option on variables.env has no effect.
After initial installation, setting
OVERLEAF_NAV_TITLE="Another title"

stopping and restarting with bin/up ; bin/start

will keep the old "My Overleaef Instance" title.
The new variables aren't picked up (the only way to get them picked is setting them up BEFORE initial bin/up)

bin/doctor shows file present but no value picked up from the file

====== Configuration ======
- config/version
    - status: present
    - version: 5.1.1
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: not set, keeping logs in container
        - SERVER_PRO: false
        - SIBLING_CONTAINERS_ENABLED: false
        - OVERLEAF_LISTEN_IP: 0.0.0.0
        - OVERLEAF_PORT: 31416
        - MONGO_ENABLED: true
        - MONGO_IMAGE: mongo
        - MONGO_VERSION: 6.0
        - MONGO_DATA_PATH: data/mongo
        - REDIS_ENABLED: true
        - REDIS_IMAGE: redis:6.2
        - REDIS_AOF_PERSISTENCE: true
        - REDIS_DATA_PATH: data/redis
        - NGINX_ENABLED: false
        - NGINX_CONFIG_PATH: config/nginx/nginx.conf
        - TLS_PRIVATE_KEY_PATH: config/nginx/certs/overleaf_key.pem
        - TLS_CERTIFICATE_PATH: config/nginx/certs/overleaf_certificate.pem
        - NGINX_HTTP_LISTEN_IP: 127.0.1.1
        - NGINX_HTTP_PORT: 80
        - NGINX_TLS_LISTEN_IP: 127.0.1.1
        - TLS_PORT: 443
        - GIT_BRIDGE_ENABLED: false
- config/variables.env
    - status: present
    - values
        - SHARELATEX_FILESTORE_BACKEND: fs
        - SHARELATEX_HISTORY_BACKEND: fs
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Warnings ======
! Detected SIBLING_CONTAINERS_ENABLED=false. When not using Sibling containers, users have full read and write access to the 'sharelatex' container resources (filesystem, network, environment variables) when running LaTeX comp
iles. Only use this mode in environments where all users are trusted and no isolation of users is required.
====== End ======

But config/variables.env has:

## Nginx
# NGINX_WORKER_PROCESSES=4
# NGINX_WORKER_CONNECTIONS=768

## Set for TLS via nginx-proxy
# OVERLEAF_BEHIND_PROXY=true
# OVERLEAF_SECURE_COOKIE=true

# OVERLEAF_SITE_URL=http://tex.ommyuc.org
OVERLEAF_NAV_TITLE="Another title"
# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
OVERLEAF_ADMIN_EMAIL="myadmin@gmail.com"

# OVERLEAF_LEFT_FOOTER='[{"text": "Contact your support team", "url": "mailto:support@example.com"}]'
# OVERLEAF_RIGHT_FOOTER='[{"text": "Hello, I am on the Right"}]'

# OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with config/variables.env and the bin/stop, bin/start, bin/up, and bin/doctor entry points to trace how environment values are loaded and passed through the toolkit. Verify the behavior with OVERLEAF_NAV_TITLE set, then stop and restart the toolkit; done means the header uses the updated title and bin/doctor reports the configured value.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
devops
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.