Skip to content
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.

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

Suggestion: Add Disclaimer for Running Projections and AtomPub Protocol in Development Mode #682

Open
CindyLoMinChung opened this issue Aug 5, 2024 · 0 comments

Comments

@CindyLoMinChung
Copy link
Contributor

Description:
I have a suggestion to improve the documentation for starting EventStoreDB in development mode. When using the --dev flag, system projections are enabled by default. However, it may not be clear that additional steps are required to enable all projections and the AtomPub protocol. To provide better guidance, I recommend adding a disclaimer or additional instructions in the documentation to include --run-projections=All and --EnableAtomPubOverHttp.

Suggestion:
Update the documentation to include a disclaimer recommending the following command for running EventStoreDB in development mode with all projections and the AtomPub protocol enabled:

EventStore.ClusterNode.exe --dev --EnableAtomPubOverHttp --db ./db --log ./logs --run-projections=All

Disclaimer:
Note: When using the --dev flag, system projections are enabled by default. To ensure all projections are running and to enable the AtomPub protocol, use --run-projections=All and --EnableAtomPubOverHttp.

Additionally, it would be a good practice to show users these configurations to ensure they are fully aware of the necessary steps to utilize EventStoreDB’s features in development mode.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant