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.

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

Improve docker UX #361

Closed
4 tasks done
josecelano opened this issue Aug 4, 2023 · 0 comments · Fixed by #367
Closed
4 tasks done

Improve docker UX #361

josecelano opened this issue Aug 4, 2023 · 0 comments · Fixed by #367
Labels
Documentation Improves Instructions, Guides, and Notices Enhancement / Feature Request Something New

Comments

@josecelano
Copy link
Member

josecelano commented Aug 4, 2023 •
edited
Loading

Relates to: #351

  • Improve the specific documentation for docker: https://github.com/torrust/torrust-tracker/tree/develop/docker
  • Write a command to generate the default storage files before running the docker image. The installation process is here, but we need to write a gist or something like that so you do not need to clone the repo.
  • We should make the same change we did for the backend. The backend allows changing the default config file location with an env var: TORRUST_IDX_BACK_CONFIG_PATH. This way could create the config file in the storage folder without injecting the env var (although env va also works).
  • Improve the error message when the config file is not found. It should say something like: "Can load the configuration file from ./config.toml"
@josecelano josecelano mentioned this issue Aug 4, 2023
Closed
@josecelano josecelano added Documentation Improves Instructions, Guides, and Notices Enhancement / Feature Request Something New labels Aug 4, 2023
@josecelano josecelano mentioned this issue Aug 7, 2023
Merged
josecelano added a commit that referenced this issue Aug 8, 2023
@josecelano
Merge #365: Fix single-command to run demo env with docker
b09e95a 
8defabd doc: [#351] fix single-command to run demo env with docker (Jose Celano)

Pull request description:

  The single command provided by the documentation to run a demo with docker did not work.

  See #351

  This PR only fixes that command and improves a little bit the documentation.

  In the short term, we need to make some improvements described [here](#361).

  In the long term, we need to make UX better. See the issue #351 for some ideas about how we can make it.

Top commit has no ACKs.

Tree-SHA512: d1a665bb9bda511fe866118d343e0cd4422f8ca69ee23cd1430df755411a3f9a847904f539e140a6b1616aadceec20b0b0652236b4b433ba9f5cdb26257a84d1
@josecelano josecelano changed the title Fix and improve docker documentation Improve docker UX Aug 8, 2023
josecelano added a commit to josecelano/torrust-tracker that referenced this issue Aug 8, 2023
@josecelano
refactor: [torrust#361] extract mod for configuration
8a79fbe
@josecelano josecelano linked a pull request Aug 8, 2023 that will close this issue
Improve docker UX #367
Merged
josecelano added a commit to josecelano/torrust-tracker that referenced this issue Aug 8, 2023
@josecelano
refactor: [torrust#361] rename constants representing env vars
0adf373 
All of then have the ENV_VAR prefix now. Like in the Index Backend.
So we can identify constants that are related to env vars.
josecelano added a commit that referenced this issue Aug 9, 2023
@josecelano
Merge #367: Improve docker UX
3bc0a8c 
ec7bd7d fix: env var name. Wrong prefix (Jose Celano)
8936c6e feat!: continue running the tracker after creating default config file (Jose Celano)
702dd14 feat: allow to change the config.toml file path (Jose Celano)
0adf373 refactor: [#361] rename constants representing env vars (Jose Celano)
8a79fbe refactor: [#361] extract mod for configuration (Jose Celano)

Pull request description:

  Some minor improvements to make using docker and the app configuration a smoother experience.

Top commit has no ACKs.

Tree-SHA512: eef1d68b78e0a228714c926881e6a09f5c859632488fbf69fd5dcdc4d34e8654835afc32d4620af7d7753a99ee2a92d8ddc49f97e055ae72b4f987aad261609c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improves Instructions, Guides, and Notices Enhancement / Feature Request Something New
Projects
Torrust Solution
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve docker UX josecelano/torrust-tracker
1 participant
@josecelano