Skip to content

add self hosting docs for azure #1954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 27, 2025
Merged

add self hosting docs for azure #1954

merged 1 commit into from
May 27, 2025

Conversation

mintlify[bot]
Copy link
Contributor

@mintlify mintlify bot commented May 27, 2025

No description provided.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 27, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Free review on us!

CodeRabbit is offering free reviews until Wed May 28 2025 to showcase some of the refinements we've made.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@UtpalJayNadiger UtpalJayNadiger merged commit 4b973bf into develop May 27, 2025
12 checks passed
greptile-apps[bot]
greptile-apps bot reviewed May 27, 2025
View reviewed changes
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

Added comprehensive documentation for self-hosting Digger on Azure, including Helm chart installation, GitHub App setup, and Azure OIDC authentication configuration.

  • File paths in code examples need to be corrected (e.g., path/to/terraform/dir should be more specific)
  • Default credentials in Helm values (abc123, salkfjadslkfj) should be replaced with secure placeholder values
  • Inconsistent file naming between mydigger.yml and digger.yml in Helm upgrade command
  • Screenshot file paths are incorrect (e.g., /docs/images/Screenshot2025-05-26at19.00.55.png doesn't exist)
  • Azure storage account name in Terraform example should use a placeholder to avoid conflicts

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

1 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile

docs/ce/self-host/self-host-on-azure.mdx

httpBasicAuthUsername: "admin"
httpBasicAuthPassword: "abc123"
bearerAuthToken: "salkfjadslkfj" # You should generate
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Default password 'abc123' and bearer token 'salkfjadslkfj' should not be included in docs as they may be copied directly. Use placeholders like '<your-secure-password>' instead

Suggested change
bearerAuthToken: "salkfjadslkfj" # You should generate
bearerAuthToken: "<your-secure-token>" # Generate a secure random token

docs/ce/self-host/self-host-on-azure.mdx
Next is to update the helmchart:

```
$ helm upgrade mydigger digger/digger-backend -f digger.yml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: File reference inconsistency: Command uses 'digger.yml' but earlier example uses 'mydigger.yml'

Suggested change
$ helm upgrade mydigger digger/digger-backend -f digger.yml
$ helm upgrade mydigger digger/digger-backend -f mydigger.yml

docs/ce/self-host/self-host-on-azure.mdx

## Configure Github workflow:

create this github workflow in your repository under `.github/workflow/digger_workflow.yml`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: Incorrect path: '.github/workflow/' should be '.github/workflows/'

Suggested change
create this github workflow in your repository under `.github/workflow/digger_workflow.yml`
create this github workflow in your repository under `.github/workflows/digger_workflow.yml`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

@motatoes motatoes motatoes approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@motatoes @UtpalJayNadiger