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

docs: extend using proxy section #4368

Merged
merged 3 commits into from
Dec 1, 2023
Merged

Conversation

gabrielmbmb
Copy link
Member

Description

This PR adds examples to the docs on how to use NGINX and Traefik as reverse proxy for Argilla server.

Closes #3706

Type of change

  • Documentation update

How Has This Been Tested

Checklist

  • I added relevant documentation
  • I followed the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • My changes generate no new warnings
  • I filled out the contributor form (see text above)
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@gabrielmbmb gabrielmbmb self-assigned this Nov 30, 2023
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. area: server Indicates that an issue or pull request is related to the server type: documentation Improvements or additions to documentation labels Nov 30, 2023
- ./nginx.conf:/etc/nginx/nginx.conf:ro

argilla:
image: argilla/argilla-quickstart:v1.20.0

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be latest right?

Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @gabrielmbmb , some small remarkts

argilla:
image: argilla/argilla-quickstart:v1.20.0
environment:
ARGILLA_ENABLE_TELEMETRY: 0

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to disable this by default I think

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is supposed to be an example, not sure if we want to enable telemetry here, right?

- "/var/run/docker.sock:/var/run/docker.sock:ro"

argilla:
image: argilla/argilla-quickstart:v1.20.0

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

argilla:
image: argilla/argilla-quickstart:v1.20.0
environment:
ARGILLA_ENABLE_TELEMETRY: 0

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Copy link

The URL of the deployed environment for this PR is https://argilla-quickstart-pr-4368-ki24f765kq-no.a.run.app

docker/nginx/docker-compose.yaml Outdated Show resolved Hide resolved
docker/traefik/docker-compose.yaml Outdated Show resolved Hide resolved
argilla:
image: argilla/argilla-quickstart:v1.20.0
environment:
ARGILLA_ENABLE_TELEMETRY: 0
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is supposed to be an example, not sure if we want to enable telemetry here, right?

@gabrielmbmb gabrielmbmb merged commit 3da7e20 into main Dec 1, 2023
17 checks passed
@gabrielmbmb gabrielmbmb deleted the docs/extend_using_proxy_section branch December 1, 2023 09:17
leiyre pushed a commit that referenced this pull request Dec 12, 2023
* develop: (21 commits)
  ✨ Fix error handling in axios plugin for 401 (#4362)
  docs: Change `telemetry` section in tutorials to directly executable cells (#4399)
  docs: add faq files (#4363)
  fix: pinning `pytest-asyncio` to version `0.21.1` to avoid problems running unit tests on GitHub workflows (#4395)
  docs: add making most of markdown to tutorial page (#4376)
  Fixing typo in Fine Tuning LLMs Practical Guides (#4392)
  Token Classification epochs parameter trainer changed (#4393)
  docs: align practical guidescreate datasethtml with end2end examples structure (#4375)
  docs: hugging face space url (#4379)
  docs: extend using proxy section (#4368)
  chore: update dev version
  chore: update CHANGELOG.md before release v1.20.0 (#4357)
  docs: temporal update to indicate persistent storage (#4355)
  docs: add suggestions and responses filters and sorting (#4345)
  docs: add end2end example on creating a basic text-classification dataset (#4208)
  Fix/responses suggestions filter fine tune (#4356)
  Fix/responses suggestions filter fine tune (#4356)
  fix: Accept draft responses on dataset records creation (#4354)
  Feature/responses operator (#4352)
  Feature/responses operator (#4352)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: server Indicates that an issue or pull request is related to the server size:M This PR changes 30-99 lines, ignoring generated files. type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants