New Configuration Pages

[nomisRev]

This PR is a draft for new configuration pages. There is a lot of duplication, which seems to send you in a circle if you follow references. This PR attempts to simplify the configuration pages, and aims to add new practical information for building Ktor applications.

1. Addressing the FAQ of which engine to use:

• By explicitly highlight Netty with tip
• Moving dependency configuration up, and moving different options down

2. Explain how to use Ktor Configuration to setup and customise users own configuration requirements
3. Add sections on how to deal with environment / system properties, and layered environment-specific configuration
4. Make more use of tabs to show different options side-by-side

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. 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.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 docstrings to generate docstrings for this 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.

[vnikolova]

What do you mean by "configuring Ktor itself"? Is it different than server configuration?

[nomisRev]

There is "Engine" configuration which is specific to the engine used "Netty", "CIO", etc.
Then there is Ktor specific configuration such as "ktor.development", "ktor.deployment.watch", "ktor.application.id", etc. Some overlap such as port and host.

These are currently split from the framework point of view, and I kept them on server-configuration because that's where they lived. I should re-add Predefined properties at the bottom of the page though.

[vnikolova]

It's confusing that the TOC title is "Server Configuration" but the topic one "Application Configuration". If I understand correctly, they are separate concepts, so we should either call this "Configuration" or "Server and application configuration". Wdyt?

[nomisRev]

This is probably oversight. I thought Server and application configuration was too long for the menu 😅
I think Server configuration, Application configuration, or Server and Application Configuration all work.

Server configuration implies both "ktor server" and "my custom server logic", similarly for Application it refers to my own Application and the Ktor Application class.

I personally have no strong opinion. It could also be moved "Ktor Configuration" to "Engines" but then we'd have to change the name and I think that might be move confusing.

[vnikolova]

Alright then, I think it makes sense to keep the Ktor configurations here as opposed to the Engines topic.
Maybe @meilalina can help with the title :)

[vnikolova]

I think this deserves a sub-section, such as "Supported formats", now that the content is merged in one topic.
We also previously mentioned that the files need to be located in the resources directory. Is this no longer a requirement?

[nomisRev]

We also previously mentioned that the files need to be located in the resources directory.
Great point! This should still be included.

Good point about the sub-section!