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

Update document: Nginx & URLs path #427

Open
wants to merge 2 commits into
base: development
Choose a base branch
from

Conversation

lcduong
Copy link
Contributor

@lcduong lcduong commented Nov 11, 2024

Update documents for how Nginx and URLs path are configured on test/live servers.

Summary by Sourcery

Documentation:

  • Add documentation for configuring Nginx and URL paths on test and live servers.

Copy link

sourcery-ai bot commented Nov 11, 2024

Reviewer's Guide by Sourcery

This PR adds a new documentation file that explains the configuration of Nginx and URL paths for test and live server environments.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added new documentation for Nginx and URL path configuration
  • Created a new RST format documentation file
  • Added information about Nginx configuration and URL paths for test and live servers
doc/deployment/nginx_and_url_path_config.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @lcduong - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The PR appears to be incomplete - please add the actual documentation content to the new file before requesting review.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +40 to +43
ssl_certificate /etc/../fullchain.pem;
ssl_certificate_key /etc/../privkey.pem;
include /etc/../options-ssl-nginx.conf;
ssl_dhparam /etc/../ssl-dhparams.pem;
Copy link

Choose a reason for hiding this comment

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

issue (documentation): The '/etc/../' path appears to be a placeholder and should be replaced with the actual path

Consider using '/etc/letsencrypt/live/domain.com/' or documenting that this needs to be replaced with the actual certificate path


With this setup:

- The URL for accessing the ``eventyay-tickets`` application control panel is ``https://app-test.eventyay.com/tickets/control``.
Copy link
Member

Choose a reason for hiding this comment

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

The documentation should be URL agnostic. If we deploy this somewhere else it does not make sense.


server {
listen 80;
server_name app-test.eventyay.com;
Copy link
Member

Choose a reason for hiding this comment

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

The documentation should be URL agnostic. If we deploy this somewhere else it does not make sense.


- **/tickets**:
- This location is for the ``eventyay-tickets`` application.
- Requests to ``https://app-test.eventyay.com/tickets/`` are proxied to ``localhost:8455/``.
Copy link
Member

Choose a reason for hiding this comment

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

The documentation should be URL agnostic. If we deploy this somewhere else it does not make sense.

Copy link
Member

@mariobehling mariobehling left a comment

Choose a reason for hiding this comment

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

Please see comments.

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

Successfully merging this pull request may close these issues.

2 participants