docs: Document the serverDirectory constructor argument#705
Closed
marcelomendoncasoares wants to merge 2 commits into
Closed
docs: Document the serverDirectory constructor argument#705marcelomendoncasoares wants to merge 2 commits into
serverDirectory constructor argument#705marcelomendoncasoares wants to merge 2 commits into
Conversation
Both serverDirectory and config are passed to the Serverpod constructor, so the section belongs under Configure in Dart rather than ahead of the YAML files. Give it a noun-shaped heading like the other subsections and tighten the prose.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
Serverpodconstructor takes aserverDirectory, which decides where configuration, passwords, migrations, and relative database paths are resolved from. It was undocumented, so anyone launching the server from somewhere other than the server package root had nothing to go on.Changes
ServerpodConfigobject still leavesserverDirectoryanchoring migrations and relative database paths, and that files your own code opens have to be anchored throughpod.serverDirectory.Reference