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

Add plane template #501

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

marktopper
Copy link
Contributor

@marktopper marktopper commented Mar 10, 2024

This templates allows to setup Plane v0.16-dev.

Utilities Addition

In this PR (commit 4c7cac0), I also updated the randomPassword utility method, to support a optional length parameter, to generate longer passwords.

Why customize

This template uses file mounts to overwrite some logic in the proxy service.

  • /etc/nginx/nginx.conf.custom: This is because the default nginx configuration in makeplane/proxy uses other internal host names (such as api, web, space and minio) rather than the full hostnames supported by EasyPanel (such as PROJECTNAME_api, PROJECTNAME_web, PROJECTNAME_space and PROJECTNAME_minio).
  • /custom-docker-entrypoint.sh: This is used to apply the custom nginx configuration above.

Template Issues

These was all resolved in 2ecaedb, applying the new EASYPANEL_HOST variable available in EasyPanel v1.13.5.

We are using the $(EASYPANEL_DOMAIN) option to automatically generate the domain names for the proxy and minio services. However, since this variable includes the service name, it applies the wrong domain names below:

  1. The proxy service domain name, should ideally be PROJECTNAME.INSTANCE.easypanel.host, and not PROJECTNAME-proxy.INSTANCE.easypanel.host.
  2. The WEB_URL environment in api, beat-worker and worker service should match the above domain name. Right now it applies the service name (api, beat-worker and worker) to it.
  3. The domain names for the minio service, should ideally be something like one of the following options:
    - PROJECTNAME-minio.INSTANCE.easypanel.io + PROJECTNAME-minio-console.INSTANCE.easypanel.io
    - PROJECTNAME-minio.INSTANCE.easypanel.io + console.PROJECTNAME-minio.INSTANCE.easypanel.io
  4. The AWS_S3_ENDPOINT_URL environment in api, beat-worker and worker service should match the above domain name. Right now it applies the service name (api, beat-worker and worker) to it.

Optimizations

  1. Currently, I was not able to get the api, beat-worker and worker able to connect to the minio service using the internal hostname, therefor a domain for the minio service API is required, while it would be safer to use a internal endpoint for this.
  2. Ideally, it would be nice if makeplane/proxy supported setting the hostnames by environment variables, then we can remove the custom nginx configuration and the custom entrypoint.

But this will do for now.

Copy link

netlify bot commented Mar 10, 2024

Deploy Preview for easypanel-templates ready!

Name Link
🔨 Latest commit 7ad680b
🔍 Latest deploy log https://app.netlify.com/sites/easypanel-templates/deploys/6628dd3c125bfa00080bbfa6
😎 Deploy Preview https://deploy-preview-501--easypanel-templates.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@marktopper
Copy link
Contributor Author

@deiucanta This has been updated to use the new EASYPANEL_HOST variable + the addition of more configuration options.

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