[feature]: Improve Docker Deployment and Documentation

[nicolinux]

Is there an existing issue for this?

• I have searched the existing issues

Summary

1. Plane does not tell you which port it will run on and assumes it is the only service on the machine. I have tons of docker containers deployed on my docker host and it would have been nice to know that it needs port 3000. Btw. port 3000 clashes with the Gitea default port (and I am sure others.

2. The installation just deploys services and there is no compose file to look at and customize but a proprietary command line tool. It would be nice to at least mention this in the installation script.

Why should this be worked on?

1. It would be nice to have a compose file to study and change for setups that you have not accounted for.
2. It would be helpful to be able to change the port Plane listens on.

[lqthien]

Pretty sure the port 3000 is for internal use of the plane docker network. Check NGINX_PORT in plane.env during your setup. It's the only system port that the whole selfhost docker stack is taking for me (I set it to 9999 btw). Make sure requests goes into it (via nginx or whatever your setup is) and the plane network/proxy takes it from there to do its propagating.

Regarding docker compose files, if you run plane locally, you can check docker-compose.yml and docker-compose-local.yml in the source code root directory. If you run the selfhost version, check plane-selfhost/plane-app/docker-compose.yaml (after running the initial sh script).

[mguptahub]

@nicolinux

I am not sure if you are trying the deployment as per docs or you are trying to run the code locally.

If you go by as per docs, you would be using setup.sh which downloads the docker-compose.yml and plane.env. Both are available for you to play around. Here, you can configure NGINX port to change as per your choice.

If you are looking at running the code locally, check the CONTRIBUTING.md

Happy to help you if you have any further questions.