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

Updated Nginx and proxy documents, added discord link to index.md page. #27

Merged
merged 1 commit into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions docs/Advanced/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,26 @@ description: Reverse proxy setup instructions
hide_table_of_contents: true
id: Proxy
---
To put Yacht behind a reverse proxy you'll need to enable websockets support as Logs, Stats, and the Dashboard use websockets.
Putting Yacht behind a webproxy is easy, we recommend the following setup.

- In Nginx Proxy Manager this is done by enabling "Websockets Support".
- For a standard nginx setup you'll need to add the following to your Yacht location block:
Using the container or setup from: https://github.com/NginxProxyManager/nginx-proxy-manager

```conf
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
```
The following configuration:

- Used to "websocket support was required", this is no longer true. It is recommended but Yacht will work without it.
- Using a subdomain such as "yacht.domain.com"
- Using https and forcing SSL
- Set the Yacht container to bridged network
- Leave Nginx Proxy Manager on its default proxy network.

Configure Nginx using the subdomain.
- The IP of the docker host (such as 192.168.0.x or equiv.).
- The docker port you set Yacht to such as 8000.
- Use http between the Nginx host and the Yacht container.

Additional security:
- Limit your firewall access to allow communication from Yacht to Nginx host on specified port only.
- Your have to research this and lock down your firewall your self, we can not provide support for this.

![proxy_screenshot.png](proxy_screenshot.png)
![proxy_screenshot2.png](proxy_screenshot2.png)
Binary file added docs/Advanced/proxy_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Advanced/proxy_screenshot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ slug: /

A web interface for managing docker containers with an emphasis on templating to provide one-click deployments of dockerized applications. Think of it like a decentralized app store for servers that anyone can make packages for.

## Features
Additional support and community assistance can be found in our Discord group, https://discord.gg/JfsebxqKDW

- Container templating compatibility (Portainer compatible)

## Features- Container templating compatibility (Portainer compatible)
- Basic container management
- Easy template updating
- Template Variables to allow for a one-click experience
Expand Down