GUACAMOLE-374: Generalize documentation for usage with both native and Docker installations. #261
Conversation
This file contains 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
mike-jumper
changed the title
mike-jumper
force-pushed
the
generalize-docker
branch
8 times, most recently
from
86f55c4 to
6f60c76
Compare
|
@mike-jumper This is still marked as a draft. Anything major need to be done before it gets reviewed? |
|
Dive right in! There are outstanding changes, but the files that have been modified thus far are ready to go. The tasks that remain are to update the following docs to use the new combined native+Docker approach:
and the following needs to be updated to no longer use legacy Docker links:
|
necouchman
requested changes
Nov 17, 2024
mike-jumper
force-pushed
the
generalize-docker
branch
from
fa4032a to
59ea07a
Compare
…from properties file snippets.
…spects of extensions.
mike-jumper
force-pushed
the
generalize-docker
branch
from
59ea07a to
417d701
Compare
…tion to combined native+Docker approach.
…ed native+Docker approach.
…ned native+Docker approach.
…ng of IP address considerations.
…hen as bulleted list.
…ive+Docker approach.
mike-jumper
force-pushed
the
generalize-docker
branch
from
417d701 to
9bd9985
Compare
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.
These changes aim to generalize the documentation around configuring Guacamole and its extensions such that necessary steps for both native and Docker installations are equally clear.
Each set of configuration properties for a supported extension has been extracted into a skeleton
.properties.infile that is processed as part of the build to produce:guacamole.propertiescontaining the documented properties and placeholder values.environmentsection for adocker-compose.ymlcontaining the documented environment variables and placeholder values.docker runcommand specifying the documented environment variables and placeholder values using the-eoption.Those various generated files are then included in the documentation, with sections split across "Native (Tomcat)" and "Container (Docker)" tabs.
(Opening as a draft for now, as these changes only contain changes to the Duo docs. I've not yet migrated the docs for the other extensions.)