feat: Easy Install #5461

yuhongsun96 · 2025-09-20T02:10:16Z

Description

1 command install of Onyx

How Has This Been Tested?

Ran locally, some concerns:

Changed the file name to be default docker compose to simplify things, may confuse some people who have existing deployments
The deployment is simply called onyx now instead of onyx-stack
Not tested on Linux/Windows machines
chmod +x on the file may in tiny percentage of servers be blocked

Backporting (check the box to trigger backport action)

Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.

This PR should be backported (make sure to check that the backport attempt succeeds)
[Optional] Override Linear Check

Summary by cubic

Adds a one-command Docker Compose install with a guided script, a single compose file, and an env template to make setup fast and consistent. Also standardizes config names (DANSWER_BOT_* → ONYX_BOT_, LOG_DANSWER_ → LOG_ONYX_*) and cleans up nginx/web configs.

New Features
- Added deployment/docker_compose/install.sh for a guided “1 command” install.
- Unified to one deployment/docker_compose/docker-compose.yml and a new env.template.
- Simplified nginx configs; introduced app.conf.template.prod for HTTPS setups.
- Updated ECS/Compose to reference the right nginx template variants.
Migration
- Rename all DANSWER_BOT_* envs to ONYX_BOT_* (including Slack tokens) and LOG_DANSWER_MODEL_INTERACTIONS to LOG_ONYX_MODEL_INTERACTIONS.
- Helm values and VSCode templates updated; align any custom overrides accordingly.
- Removed NEXT_PUBLIC_DISABLE_STREAMING and NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA from web build/runtime.
- For Compose users, use the new install flow: cd deployment/docker_compose && ./install.sh; for prod, use the .prod nginx template.

vercel · 2025-09-20T02:10:20Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
internal-search	Ready	Preview	Comment	Sep 21, 2025 10:32pm

greptile-apps

Greptile Summary

This PR introduces an 'Easy Install' feature that enables one-command deployment of Onyx through significant infrastructure changes and comprehensive rebranding. The changes span three main areas:

Docker Compose Consolidation: Multiple docker-compose files (gpu-dev, dev, prod variants) have been consolidated into a single unified docker-compose.yml with comprehensive documentation and production guidance. A new installation script (install.sh) provides automated setup with colorized output, health checks, and resource validation. The new env.template centralizes all configuration variables with sensible defaults, replacing scattered environment variable declarations.

Systematic Rebranding: All configuration variables, environment settings, and internal references have been updated from 'DANSWER' to 'ONYX' prefixes. This includes Slack bot configurations (DANSWER_BOT_* → ONYX_BOT_*), model interaction logging (LOG_DANSWER_MODEL_INTERACTIONS → LOG_ONYX_MODEL_INTERACTIONS), and related imports across backend services. Some emoji configurations retain the old naming, creating minor inconsistencies.

Configuration Simplification: Several frontend build arguments have been removed (NEXT_PUBLIC_DISABLE_STREAMING, NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA) to reduce deployment complexity. Nginx configurations have been streamlined with production-ready templates (app.conf.template.prod) that include SSL/TLS support, header mapping, and security considerations. The QA_PROMPT_OVERRIDE configuration has been deprecated and removed.

The changes integrate by creating a cohesive deployment experience where users can run a single installation script that downloads the unified docker-compose configuration, sets up the environment file with working defaults, and launches all services with proper dependencies and health monitoring.

Confidence score: 2/5

This PR has several critical issues that will prevent successful deployment, particularly malformed YAML syntax and broken file references
Score reflects serious deployment-breaking issues in CloudFormation templates and potential missing nginx configuration files
Pay close attention to AWS CloudFormation templates, nginx template references, and the installation script's hardcoded branch references

_{28 files reviewed, 12 comments}

_{Edit Code Review Bot Settings | Greptile}

greptile-apps · 2025-09-20T02:11:54Z

deployment/aws_ecs_fargate/cloudformation/services/onyx_web_server_service_template.yaml

          Environment:
-            - Name: NEXT_PUBLIC_DISABLE_STREAMING
-              Value: "false"
-            - Name: NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA
              Value: "false"


syntax: Syntax error: orphaned 'Value: "false"' without corresponding 'Name' field. This will cause CloudFormation deployment to fail.

Suggested change

Environment:

- Name: NEXT_PUBLIC_DISABLE_STREAMING

Value: "false"

- Name: NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA

Value: "false"

Environment:

- Name: INTERNAL_URL

greptile-apps · 2025-09-20T02:11:55Z

deployment/docker_compose/install.sh

+print_step "Setting up nginx configuration"
+
+# Base URL for nginx files
+NGINX_BASE_URL="https://raw.githubusercontent.com/onyx-dot-app/onyx/docker-compose-easy/deployment/data/nginx"


logic: Same hardcoded branch issue here. Consider using a variable for branch name.

Suggested change

NGINX_BASE_URL="https://raw.githubusercontent.com/onyx-dot-app/onyx/docker-compose-easy/deployment/data/nginx"

NGINX_BASE_URL="https://raw.githubusercontent.com/onyx-dot-app/onyx/main/deployment/data/nginx"

greptile-apps · 2025-09-20T02:11:56Z

deployment/docker_compose/install.sh

+cd onyx_data/deployment && $COMPOSE_CMD -f docker-compose.yml pull && cd ../..
+
+# Start services
+print_step "Starting Onyx services"
+print_info "Launching containers..."
+echo ""
+cd onyx_data/deployment && $COMPOSE_CMD -f docker-compose.yml up -d && cd ../..


logic: Directory changes without proper error handling. If cd fails, subsequent commands run in wrong location.

greptile-apps · 2025-09-20T02:11:57Z

deployment/docker_compose/docker-compose.yml

+        max-file: "6"
+    # The specified script waits for the api_server to start up.
+    # Without this we've seen issues where nginx shows no error logs but
+    # does not recieve any traffic


syntax: Typo in comment: 'recieve' should be 'receive'

Suggested change

# does not recieve any traffic

# does not receive any traffic

greptile-apps · 2025-09-20T02:11:57Z

web/Dockerfile


-ARG NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA
-ENV NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA=${NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA}



style: Unnecessary empty lines left from removed environment variables. Clean up whitespace.

greptile-apps · 2025-09-20T02:11:58Z

web/Dockerfile


-ARG NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA
-ENV NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA=${NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA}



style: Unnecessary empty lines left from removed environment variables. Clean up whitespace.

greptile-apps · 2025-09-20T02:11:59Z

deployment/docker_compose/env.template

+################################################################################
+## Database Configuration
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=password


style: Using 'password' as default for production template poses security risk

greptile-apps · 2025-09-20T02:11:59Z

deployment/docker_compose/env.template

+MODEL_SERVER_HOST=inference_model_server
+INDEXING_MODEL_SERVER_HOST=indexing_model_server


logic: Duplicate MODEL_SERVER_HOST assignment - line 214 also sets this variable

cubic-dev-ai

21 issues found across 30 files

Prompt for AI agents (all 21 issues)


Understand the root cause of the following 21 issues and fix them.


<file name="deployment/docker_compose/docker-compose.prod-no-letsencrypt.yml">

<violation number="1" location="deployment/docker_compose/docker-compose.prod-no-letsencrypt.yml:233">
Nonexistent nginx template referenced; container will fail to generate config</violation>
</file>

<file name="backend/onyx/onyxbot/slack/handlers/handle_message.py">

<violation number="1" location="backend/onyx/onyxbot/slack/handlers/handle_message.py:55">
Guarding with `not` allows negative values; a negative reminder offset results in a past timestamp. Use `&lt;= 0` to disable on non-positive values, or clamp at parse time for safety.

(Based on your team&#39;s feedback about validating env-derived timeout multipliers at parse time and providing a safe default.)</violation>
</file>

<file name="backend/onyx/configs/app_configs.py">

<violation number="1" location="backend/onyx/configs/app_configs.py:670">
Breaking change: env var renamed without backward-compatible fallback; existing LOG_DANSWER_MODEL_INTERACTIONS will be ignored.</violation>
</file>

<file name="backend/onyx/onyxbot/slack/utils.py">

<violation number="1" location="backend/onyx/onyxbot/slack/utils.py:92">
Negative response-limit values will block all messages; treat &lt;= 0 as unlimited instead of only == 0.</violation>

<violation number="2" location="backend/onyx/onyxbot/slack/utils.py:107">
Global message counter is updated without synchronization, leading to race conditions under concurrent requests.</violation>

<violation number="3" location="backend/onyx/onyxbot/slack/utils.py:211">
Guard retry tries to be &gt;= 1 so a misconfigured env (0/negative) doesn’t disable retries.</violation>

<violation number="4" location="backend/onyx/onyxbot/slack/utils.py:648">
Normalize max_qpm: treat negatives as unlimited (None) or clamp to a positive value to avoid permanently blocking requests.</violation>

<violation number="5" location="backend/onyx/onyxbot/slack/utils.py:649">
Clamp max_wait_time to non-negative to avoid immediate TimeoutError with a misconfigured negative value.</violation>

<violation number="6" location="backend/onyx/onyxbot/slack/utils.py:709">
Strip whitespace before lowercasing to handle env values with accidental spaces.</violation>
</file>

<file name="deployment/aws_ecs_fargate/cloudformation/services/onyx_nginx_service_template.yaml">

<violation number="1" location="deployment/aws_ecs_fargate/cloudformation/services/onyx_nginx_service_template.yaml:160">
curl download lacks --fail; HTTP 4xx/5xx won&#39;t break the chain, risking invalid config being used.</violation>
</file>

<file name="deployment/docker_compose/docker-compose.yml">

<violation number="1" location="deployment/docker_compose/docker-compose.yml:159">
Case-sensitive check prevents disabling model server when DISABLE_MODEL_SERVER=true; compare to &quot;true&quot; (lowercase) to match env defaults.</violation>

<violation number="2" location="deployment/docker_compose/docker-compose.yml:295">
Avoid floating image tag for MinIO; pin to a specific release for reproducibility and safer upgrades.</violation>
</file>

<file name="deployment/docker_compose/install.sh">

<violation number="1" location="deployment/docker_compose/install.sh:58">
Hard-coding a feature branch (docker-compose-easy) makes installs fragile and non-reproducible; use a stable ref such as main or a pinned tag/commit.</violation>

<violation number="2" location="deployment/docker_compose/install.sh:202">
Downloading from a moving feature branch risks breakage; point to a stable ref like main or a pinned tag/commit.</violation>

<violation number="3" location="deployment/docker_compose/install.sh:253">
Using cd ... &amp;&amp; ... &amp;&amp; cd ../.. with set -e can leave the script in the wrong directory if the middle command fails; wrap the operation in a subshell to avoid side effects and ensure proper failure behavior.</violation>
</file>

<file name="deployment/helm/charts/onyx/values.yaml">

<violation number="1" location="deployment/helm/charts/onyx/values.yaml:859">
Added env var ONYX_BOT_DISABLE_COT appears unused; consider removing it or wiring it into the app to avoid configuration drift.</violation>
</file>

<file name="deployment/data/nginx/app.conf.template">

<violation number="1" location="deployment/data/nginx/app.conf.template:38">
Overwrites X-Forwarded-* with $scheme/$host/$server_port, dropping upstream values; behind a TLS-terminating proxy this can misreport https→http (and 443→80), causing incorrect redirects/cookie/security behavior. Reintroduce fallback to $http_x_forwarded_* (via map) or otherwise preserve upstream headers.</violation>
</file>

<file name="deployment/data/nginx/app.conf.template.prod">

<violation number="1" location="deployment/data/nginx/app.conf.template.prod:56">
Do not trust client-supplied X-Forwarded-Proto on public :80; set it from $scheme or restrict to trusted proxies.</violation>

<violation number="2" location="deployment/data/nginx/app.conf.template.prod:57">
Avoid propagating client X-Forwarded-Host on :80; set from $host instead.</violation>

<violation number="3" location="deployment/data/nginx/app.conf.template.prod:58">
Do not trust client X-Forwarded-Port on :80; set from $server_port.</violation>
</file>

<file name="deployment/docker_compose/env.template">

<violation number="1" location="deployment/docker_compose/env.template:155">
Duplicate environment variable definition for MODEL_SERVER_HOST; later entry overrides the earlier one. Remove the duplicate to avoid confusion.</violation>
</file>

Since this is your first cubic review, here's how it works:

cubic automatically reviews your code and comments on bugs and improvements
Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
Ask questions if you need clarification on any suggestion

_{React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.}

cubic-dev-ai · 2025-09-20T02:27:00Z

deployment/docker_compose/docker-compose.prod-no-letsencrypt.yml

    command: >
      /bin/sh -c "dos2unix /etc/nginx/conf.d/run-nginx.sh 
-      && /etc/nginx/conf.d/run-nginx.sh app.conf.template.no-letsencrypt"
+      && /etc/nginx/conf.d/run-nginx.sh app.conf.template.prod.no-letsencrypt"


Nonexistent nginx template referenced; container will fail to generate config

Prompt for AI agents

Address the following comment on deployment/docker_compose/docker-compose.prod-no-letsencrypt.yml at line 233: <comment>Nonexistent nginx template referenced; container will fail to generate config</comment> <file context> @@ -232,7 +230,7 @@ services: command: > /bin/sh -c "dos2unix /etc/nginx/conf.d/run-nginx.sh - && /etc/nginx/conf.d/run-nginx.sh app.conf.template.no-letsencrypt" + && /etc/nginx/conf.d/run-nginx.sh app.conf.template.prod.no-letsencrypt" env_file: - .env.nginx </file context>

Suggested change

&& /etc/nginx/conf.d/run-nginx.sh app.conf.template.prod.no-letsencrypt"

&& /etc/nginx/conf.d/run-nginx.sh app.conf.template.no-letsencrypt"

cubic-dev-ai · 2025-09-20T02:27:00Z

backend/onyx/onyxbot/slack/handlers/handle_message.py

    logger = setup_logger(extra={SLACK_CHANNEL_ID: details.channel_to_respond})

-    if not DANSWER_BOT_FEEDBACK_REMINDER:
+    if not ONYX_BOT_FEEDBACK_REMINDER:


Guarding with not allows negative values; a negative reminder offset results in a past timestamp. Use <= 0 to disable on non-positive values, or clamp at parse time for safety.

(Based on your team's feedback about validating env-derived timeout multipliers at parse time and providing a safe default.)

Prompt for AI agents

Address the following comment on backend/onyx/onyxbot/slack/handlers/handle_message.py at line 55: <comment>Guarding with `not` allows negative values; a negative reminder offset results in a past timestamp. Use `<= 0` to disable on non-positive values, or clamp at parse time for safety. (Based on your team's feedback about validating env-derived timeout multipliers at parse time and providing a safe default.)</comment> <file context> @@ -52,7 +52,7 @@ def schedule_feedback_reminder( logger = setup_logger(extra={SLACK_CHANNEL_ID: details.channel_to_respond}) - if not DANSWER_BOT_FEEDBACK_REMINDER: + if not ONYX_BOT_FEEDBACK_REMINDER: logger.info("Scheduled feedback reminder disabled...") return None </file context>

backend/onyx/configs/app_configs.py

cubic-dev-ai · 2025-09-20T02:27:01Z

backend/onyx/onyxbot/slack/utils.py

 def get_feedback_visibility() -> FeedbackVisibility:
    try:
-        return FeedbackVisibility(DANSWER_BOT_FEEDBACK_VISIBILITY.lower())
+        return FeedbackVisibility(ONYX_BOT_FEEDBACK_VISIBILITY.lower())


Strip whitespace before lowercasing to handle env values with accidental spaces.

Prompt for AI agents

Address the following comment on backend/onyx/onyxbot/slack/utils.py at line 709: <comment>Strip whitespace before lowercasing to handle env values with accidental spaces.</comment> <file context> @@ -706,7 +706,7 @@ def waiter(self, func_randid: int) -> None: def get_feedback_visibility() -> FeedbackVisibility: try: - return FeedbackVisibility(DANSWER_BOT_FEEDBACK_VISIBILITY.lower()) + return FeedbackVisibility(ONYX_BOT_FEEDBACK_VISIBILITY.lower()) except ValueError: return FeedbackVisibility.PRIVATE </file context>

Suggested change

return FeedbackVisibility(ONYX_BOT_FEEDBACK_VISIBILITY.lower())

return FeedbackVisibility(ONYX_BOT_FEEDBACK_VISIBILITY.strip().lower())

cubic-dev-ai · 2025-09-20T02:27:01Z

backend/onyx/onyxbot/slack/utils.py

-        self.max_qpm: int | None = DANSWER_BOT_MAX_QPM
-        self.max_wait_time = DANSWER_BOT_MAX_WAIT_TIME
+        self.max_qpm: int | None = ONYX_BOT_MAX_QPM
+        self.max_wait_time = ONYX_BOT_MAX_WAIT_TIME


Clamp max_wait_time to non-negative to avoid immediate TimeoutError with a misconfigured negative value.

Prompt for AI agents

Address the following comment on backend/onyx/onyxbot/slack/utils.py at line 649: <comment>Clamp max_wait_time to non-negative to avoid immediate TimeoutError with a misconfigured negative value.</comment> <file context> @@ -645,8 +645,8 @@ def slack_usage_report(action: str, sender_id: str | None, client: WebClient) -> - self.max_qpm: int | None = DANSWER_BOT_MAX_QPM - self.max_wait_time = DANSWER_BOT_MAX_WAIT_TIME + self.max_qpm: int | None = ONYX_BOT_MAX_QPM + self.max_wait_time = ONYX_BOT_MAX_WAIT_TIME self.active_question = 0 self.last_reset_time = time.time() </file context>

Suggested change

self.max_wait_time = ONYX_BOT_MAX_WAIT_TIME

self.max_wait_time = max(0, ONYX_BOT_MAX_WAIT_TIME)

cubic-dev-ai · 2025-09-20T02:27:02Z

deployment/data/nginx/app.conf.template

-        proxy_set_header X-Forwarded-Proto $forwarded_proto;
-        proxy_set_header X-Forwarded-Host $forwarded_host; 
-        proxy_set_header X-Forwarded-Port $forwarded_port;
+        proxy_set_header X-Forwarded-Proto $scheme;


Overwrites X-Forwarded-* with $scheme/$host/$server_port, dropping upstream values; behind a TLS-terminating proxy this can misreport https→http (and 443→80), causing incorrect redirects/cookie/security behavior. Reintroduce fallback to $http_x_forwarded_* (via map) or otherwise preserve upstream headers.

Prompt for AI agents

Address the following comment on deployment/data/nginx/app.conf.template at line 38: <comment>Overwrites X-Forwarded-* with $scheme/$host/$server_port, dropping upstream values; behind a TLS-terminating proxy this can misreport https→http (and 443→80), causing incorrect redirects/cookie/security behavior. Reintroduce fallback to $http_x_forwarded_* (via map) or otherwise preserve upstream headers.</comment> <file context> @@ -53,9 +35,9 @@ server { - proxy_set_header X-Forwarded-Proto $forwarded_proto; - proxy_set_header X-Forwarded-Host $forwarded_host; - proxy_set_header X-Forwarded-Port $forwarded_port; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-Host $host; + proxy_set_header X-Forwarded-Port $server_port; </file context>

cubic-dev-ai · 2025-09-20T02:27:02Z

deployment/data/nginx/app.conf.template.prod

-        proxy_set_header X-Forwarded-Host $host;
-        proxy_set_header X-Forwarded-Port $server_port;
+        proxy_set_header X-Forwarded-Proto $forwarded_proto;
+        proxy_set_header X-Forwarded-Host $forwarded_host; 


Avoid propagating client X-Forwarded-Host on :80; set from $host instead.

Prompt for AI agents

Address the following comment on deployment/data/nginx/app.conf.template.prod at line 57: <comment>Avoid propagating client X-Forwarded-Host on :80; set from $host instead.</comment> <file context> @@ -35,9 +53,9 @@ server { - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; + proxy_set_header X-Forwarded-Proto $forwarded_proto; + proxy_set_header X-Forwarded-Host $forwarded_host; + proxy_set_header X-Forwarded-Port $forwarded_port; proxy_set_header Host $host; </file context>

Suggested change

proxy_set_header X-Forwarded-Host $forwarded_host;

proxy_set_header X-Forwarded-Host $host;

cubic-dev-ai · 2025-09-20T02:27:02Z

deployment/data/nginx/app.conf.template.prod

-        proxy_set_header X-Forwarded-Proto $scheme;
-        proxy_set_header X-Forwarded-Host $host;
-        proxy_set_header X-Forwarded-Port $server_port;
+        proxy_set_header X-Forwarded-Proto $forwarded_proto;


Do not trust client-supplied X-Forwarded-Proto on public :80; set it from $scheme or restrict to trusted proxies.

Prompt for AI agents

Address the following comment on deployment/data/nginx/app.conf.template.prod at line 56: <comment>Do not trust client-supplied X-Forwarded-Proto on public :80; set it from $scheme or restrict to trusted proxies.</comment> <file context> @@ -35,9 +53,9 @@ server { - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; + proxy_set_header X-Forwarded-Proto $forwarded_proto; + proxy_set_header X-Forwarded-Host $forwarded_host; + proxy_set_header X-Forwarded-Port $forwarded_port; </file context>

Suggested change

proxy_set_header X-Forwarded-Proto $forwarded_proto;

proxy_set_header X-Forwarded-Proto $scheme;

cubic-dev-ai · 2025-09-20T02:27:02Z

deployment/data/nginx/app.conf.template.prod

-        proxy_set_header X-Forwarded-Port $server_port;
+        proxy_set_header X-Forwarded-Proto $forwarded_proto;
+        proxy_set_header X-Forwarded-Host $forwarded_host; 
+        proxy_set_header X-Forwarded-Port $forwarded_port;


Do not trust client X-Forwarded-Port on :80; set from $server_port.

Prompt for AI agents

Address the following comment on deployment/data/nginx/app.conf.template.prod at line 58: <comment>Do not trust client X-Forwarded-Port on :80; set from $server_port.</comment> <file context> @@ -35,9 +53,9 @@ server { - proxy_set_header X-Forwarded-Port $server_port; + proxy_set_header X-Forwarded-Proto $forwarded_proto; + proxy_set_header X-Forwarded-Host $forwarded_host; + proxy_set_header X-Forwarded-Port $forwarded_port; proxy_set_header Host $host; </file context>

Suggested change

proxy_set_header X-Forwarded-Port $forwarded_port;

proxy_set_header X-Forwarded-Port $server_port;

cubic-dev-ai · 2025-09-20T02:27:02Z

deployment/docker_compose/env.template

+# USE_SEMANTIC_KEYWORD_EXPANSIONS_BASIC_SEARCH=
+
+## Model Configuration
+MODEL_SERVER_HOST=inference_model_server


Duplicate environment variable definition for MODEL_SERVER_HOST; later entry overrides the earlier one. Remove the duplicate to avoid confusion.

Prompt for AI agents

Address the following comment on deployment/docker_compose/env.template at line 155: <comment>Duplicate environment variable definition for MODEL_SERVER_HOST; later entry overrides the earlier one. Remove the duplicate to avoid confusion.</comment> <file context> @@ -0,0 +1,215 @@ +# USE_SEMANTIC_KEYWORD_EXPANSIONS_BASIC_SEARCH= + +## Model Configuration +MODEL_SERVER_HOST=inference_model_server +INDEXING_MODEL_SERVER_HOST=indexing_model_server +# EMBEDDING_BATCH_SIZE= </file context>

Suggested change

MODEL_SERVER_HOST=inference_model_server

# MODEL_SERVER_HOST=inference_model_server

✅ Addressed in e44a636

yuhongsun96 · 2025-09-20T23:37:42Z

backend/onyx/configs/onyxbot_configs.py

 # Onyx Slack Bot Configs
 #####
-DANSWER_BOT_NUM_RETRIES = int(os.environ.get("DANSWER_BOT_NUM_RETRIES", "5"))
+ONYX_BOT_NUM_RETRIES = int(os.environ.get("ONYX_BOT_NUM_RETRIES", "5"))


These slackbot changes are minimally risky imo. Since they are default off riskier behaviors like responding in every channel, it shouldn't cause any issues if they no longer apply. Also some of these I suspect don't work anyway.

This also implies that the new env variable is set properly and can be retrieved. I think it's a matter of making sure the new one is there not so much that the old was stays or not.

Do feel like this is quite risky.

The ones that don't work (I removed some), don't feel super critical. It's outside the scope of this PR. My only concern is with variable renaming when some people might still be deploying with old vars and this becoming a "regression" even though it's not.

But reading through what they do, I'm not too concerned about that case.

yuhongsun96 · 2025-09-20T23:44:40Z

deployment/aws_ecs_fargate/cloudformation/services/onyx_web_server_service_template.yaml

              HostPort: 3000
              Protocol: tcp
          Environment:
-            - Name: NEXT_PUBLIC_DISABLE_STREAMING


Not used I believe, might want to double check

yuhongsun96 · 2025-09-20T23:46:41Z

deployment/data/nginx/app.conf.template

 # Log format to include request latency
 log_format custom_main '$remote_addr - $remote_user [$time_local] "$request" '
                '$status $body_bytes_sent "$http_referer" '
                '"$http_user_agent" "$http_x_forwarded_for" '


Following same convention as docker compose file naming, there's a default version and a prod version, just renamed the files, the diffs here are just from git not understanding the file renamings

yuhongsun96 · 2025-09-20T23:47:43Z

deployment/data/nginx/app.conf.template.prod

                '"$http_user_agent" "$http_x_forwarded_for" '
                'rt=$request_time';

+# Map X-Forwarded-Proto or fallback to $scheme


May want to quickly sanity check that nothing is broken from the renaming. I did not test the prod setup

justin-tahara

Overall I think this PR is a bit too dangerous to just merge.

My opinion is to break this up into smaller PR's that are easier to digest and easier to read through.

Ideally the Slack bot changes are all one PR, then the compose unification is another. Helm can be it's own PR and lastly the script comes in once all of the individual workflows have been tested.

From personal experience, I do prefer Python Scripts for maintainability and ease of understanding but if this is truly a one line command approach to onyx then I can be convinced to do bash instead.

Maybe we can even have both options be available but again two things to maintain is not as easy as one.

The last thing for this is that many workflows will most likely break across the board. Many customers that have hardcoded workflows will definitely complain about this upgrade and thus we should think a bit more about the migration path and how we would introduce this to existing users of Onyx in a non-invasive way such that they are able to also upgrade easily to this new workflow.

Also if we are going to introduce the bash script or any script in general, we should have a integration or test suite to ensure that it never breaks and is the source of truth to upgrading or installing onyx.

justin-tahara · 2025-09-21T04:58:19Z

.github/workflows/pr-integration-tests.yml

      - name: Start Docker containers
        run: |
          cd deployment/docker_compose
+          cp env.template .env


Is this required to get the test to pass? Or are there other dependencies that require this to be set.

Let me try to make it not required

justin-tahara · 2025-09-21T04:59:15Z

.github/workflows/pr-playwright-tests.yml

        run: |
          echo "Starting wait-for-service script..."

-          docker logs -f danswer-stack-api_server-1 &


As long as the onyx name is correctly populated I think this is fine.

Ya it's the default now in the compose script, a lot of things are simplified now

justin-tahara · 2025-09-21T04:59:44Z

.vscode/env_template.txt

-#DANSWER_BOT_SLACK_APP_TOKEN=<REPLACE THIS>
-#DANSWER_BOT_SLACK_BOT_TOKEN=<REPLACE THIS>
+#ONYX_BOT_SLACK_APP_TOKEN=<REPLACE THIS>
+#ONYX_BOT_SLACK_BOT_TOKEN=<REPLACE THIS>


justin-tahara · 2025-09-21T05:00:03Z

backend/ee/onyx/background/celery/tasks/external_group_syncing/tasks.py

    if cc_pair.access_type != AccessType.SYNC:
        task_logger.error(
-            f"Recieved non-sync CC Pair {cc_pair.id} for external "
+            f"Received non-sync CC Pair {cc_pair.id} for external "


lmao I wanted to fix a bot comment but I realized this same typo appeared a bunch of times so just fixed it across the board

justin-tahara · 2025-09-21T05:01:28Z

backend/onyx/configs/onyxbot_configs.py

 # Onyx Slack Bot Configs
 #####
-DANSWER_BOT_NUM_RETRIES = int(os.environ.get("DANSWER_BOT_NUM_RETRIES", "5"))
+ONYX_BOT_NUM_RETRIES = int(os.environ.get("ONYX_BOT_NUM_RETRIES", "5"))


This also implies that the new env variable is set properly and can be retrieved. I think it's a matter of making sure the new one is there not so much that the old was stays or not.

Do feel like this is quite risky.

justin-tahara · 2025-09-21T05:02:32Z

backend/onyx/onyxbot/slack/handlers/handle_message.py

 from slack_sdk.errors import SlackApiError

-from onyx.configs.onyxbot_configs import DANSWER_BOT_FEEDBACK_REMINDER
 from onyx.configs.onyxbot_configs import DANSWER_REACT_EMOJI


Should we not change this one as well?

Ah it's not even a thing I think people should change to be honest... ya we should change it

justin-tahara · 2025-09-21T05:02:47Z

backend/onyx/onyxbot/slack/handlers/handle_regular_answer.py

-from onyx.configs.onyxbot_configs import DANSWER_BOT_DISABLE_DOCS_ONLY_ANSWER
-from onyx.configs.onyxbot_configs import DANSWER_BOT_DISPLAY_ERROR_MSGS
-from onyx.configs.onyxbot_configs import DANSWER_BOT_NUM_RETRIES
 from onyx.configs.onyxbot_configs import DANSWER_REACT_EMOJI


Same as above here.

justin-tahara · 2025-09-21T05:03:36Z

backend/onyx/onyxbot/slack/utils.py

    the limit to be exceeded.
    """
-    if DANSWER_BOT_RESPONSE_LIMIT_PER_TIME_PERIOD == 0:
+    if ONYX_BOT_RESPONSE_LIMIT_PER_TIME_PERIOD == 0:


I think this is a safe change that we should probably just do to be safe

justin-tahara · 2025-09-21T05:06:09Z

deployment/data/nginx/app.conf.template

Is the understanding that everything should be routed through the .prod template instead of this one? Should we even keep this one?

This is the default non SSL one. I think it's good to keep, the default deployment uses this. HTTPS setup is kind of a pain in the ass, I still don't fully understand it and we don't want to make the base deployment too painful.

justin-tahara · 2025-09-21T05:09:31Z

deployment/docker_compose/install.sh

What was the reasoning behind the Bash script? Was this more along the lines of with Bash you don't need to download anything but with Python you would need a working version of python?

I think as someone who is using docker, it probably can be assumed that they have python and so writing a python script would be nice to maintain and easier to debug in my opinion.

Open to hearing what your thoughts are

pip is the python package manager, you can reuse it to manage other packages but it's less intuitive, it's like installing Onyx with npm, probably there's some way to get that working but it's not the right tool.

The other thing is with requiring a python installation which doesn't come out of the box with most operating systems whereas bash typically does. Maybe on Windows most people have pip instead of bash but meh...

yuhongsun96 requested a review from a team as a code owner September 20, 2025 02:10

yuhongsun96 marked this pull request as draft September 20, 2025 02:10

vercel bot deployed to Preview September 20, 2025 02:11 View deployment

greptile-apps bot reviewed Sep 20, 2025

View reviewed changes

cubic-dev-ai bot reviewed Sep 20, 2025

View reviewed changes

vercel bot deployed to Preview September 20, 2025 20:27 View deployment

vercel bot deployed to Preview September 20, 2025 20:39 View deployment

vercel bot deployed to Preview September 20, 2025 21:09 View deployment

vercel bot deployed to Preview September 20, 2025 21:37 View deployment

vercel bot deployed to Preview September 20, 2025 21:55 View deployment

vercel bot deployed to Preview September 20, 2025 22:17 View deployment

vercel bot deployed to Preview September 20, 2025 22:25 View deployment

yuhongsun96 changed the title ~~Easy Install~~ feat: Easy Install Sep 20, 2025

yuhongsun96 added 13 commits September 20, 2025 16:35

nowork

dc1f3f5

test

bfb3816

ok

e271633

k

b851ea1

k

ef917ae

ok

87b79d8

k

535c882

k

b60ca4d

k

48538e9

k

d2c6ce4

k

c352345

k

a20e7c9

k

11a0728

yuhongsun96 force-pushed the docker-compose-easy branch from 1bb7402 to 11a0728 Compare September 20, 2025 23:35

yuhongsun96 commented Sep 20, 2025

View reviewed changes

vercel bot deployed to Preview September 20, 2025 23:39 View deployment

yuhongsun96 commented Sep 20, 2025

View reviewed changes

k

058bf59

yuhongsun96 commented Sep 20, 2025

View reviewed changes

k

850f918

vercel bot deployed to Preview September 20, 2025 23:53 View deployment

k

e44a636

vercel bot deployed to Preview September 20, 2025 23:57 View deployment

k

0d5177d

vercel bot deployed to Preview September 21, 2025 00:12 View deployment

k

06ec9f8

vercel bot deployed to Preview September 21, 2025 00:33 View deployment

justin-tahara reviewed Sep 21, 2025

View reviewed changes

vercel bot deployed to Preview September 21, 2025 21:09 View deployment

yuhongsun96 force-pushed the docker-compose-easy branch from a3f02f3 to 06ec9f8 Compare September 21, 2025 21:11

onyx-stack

264d94c

vercel bot deployed to Preview September 21, 2025 21:18 View deployment

no-env-file-test

e905433

vercel bot deployed to Preview September 21, 2025 21:58 View deployment

k

8007b37

vercel bot deployed to Preview September 21, 2025 22:09 View deployment

k

12ecad0

vercel bot deployed to Preview September 21, 2025 22:28 View deployment

k

13a4aa0

vercel bot deployed to Preview September 21, 2025 22:32 View deployment

yuhongsun96 requested a review from justin-tahara September 21, 2025 23:01

	NGINX_BASE_URL="https://raw.githubusercontent.com/onyx-dot-app/onyx/docker-compose-easy/deployment/data/nginx"
	NGINX_BASE_URL="https://raw.githubusercontent.com/onyx-dot-app/onyx/main/deployment/data/nginx"

	# does not recieve any traffic
	# does not receive any traffic


		ARG NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA
		ENV NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA=${NEXT_PUBLIC_NEW_CHAT_DIRECTS_TO_SAME_PERSONA}

		MODEL_SERVER_HOST=inference_model_server
		INDEXING_MODEL_SERVER_HOST=indexing_model_server

	&& /etc/nginx/conf.d/run-nginx.sh app.conf.template.prod.no-letsencrypt"
	&& /etc/nginx/conf.d/run-nginx.sh app.conf.template.no-letsencrypt"

	return FeedbackVisibility(ONYX_BOT_FEEDBACK_VISIBILITY.lower())
	return FeedbackVisibility(ONYX_BOT_FEEDBACK_VISIBILITY.strip().lower())

	self.max_wait_time = ONYX_BOT_MAX_WAIT_TIME
	self.max_wait_time = max(0, ONYX_BOT_MAX_WAIT_TIME)

	proxy_set_header X-Forwarded-Host $forwarded_host;
	proxy_set_header X-Forwarded-Host $host;

	proxy_set_header X-Forwarded-Proto $forwarded_proto;
	proxy_set_header X-Forwarded-Proto $scheme;

	proxy_set_header X-Forwarded-Port $forwarded_port;
	proxy_set_header X-Forwarded-Port $server_port;

	MODEL_SERVER_HOST=inference_model_server
	# MODEL_SERVER_HOST=inference_model_server

feat: Easy Install #5461

Are you sure you want to change the base?

feat: Easy Install #5461

Conversation

yuhongsun96 commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Backporting (check the box to trigger backport action)

Summary by cubic

Uh oh!

vercel bot commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Greptile Summary

Confidence score: 2/5

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

yuhongsun96 commented Sep 20, 2025 •

edited

Loading

vercel bot commented Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading

cubic-dev-ai bot Sep 20, 2025 •

edited

Loading