OpenSignLabs / OpenSign

🔥 The free & Open Source DocuSign alternative
https://www.opensignlabs.com
GNU Affero General Public License v3.0
3.32k stars 262 forks source link

[Bug]: Self Hosted Docker Documentation Issue #1371

Open PereProteus opened 3 weeks ago

PereProteus commented 3 weeks ago

Issue Description

The documentation outlines the SERVER_URL here: https://docs.opensignlabs.com/docs/self-host/docker/run-locally/#information-about-env-variables-which-are-used-to-setup-opensign-with-docker-on-localhost

It is currently listed as: image

When you edit the recommended environment file from here: https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev

You get the following: image

Additionally there is a SERVER_URL in the docker-compose file: image

Which SERVER_URL endpoint is correct for which file? specifically which port and endpoint? at the moment both the 'server' and 'client' URLs are mixed and matched between documentation.

Expected Behavior

Expect to have uniform documentation.

Current Behavior

Not uniform or clear documentation

Steps to reproduce

Review the above URLs

Screenshots of the issue(optional)

As above.

Operating System [e.g. MacOS Sonoma 14.1, Windows 11]

Docker

What browsers are you seeing the problem on?

No response

What version of OpenSign™ are you seeing this issue on? [e.g. 1.0.6]

=2.5.0

What environment are you seeing the problem on?

Hosted (app.yourdomain.com)

Please check the boxes that apply to this issue report.

Code of Conduct

PereProteus commented 3 weeks ago

Note: I appreciate port 3001 is based on caddy, but it doesnt make it clear if 8080 or 3000 is the core SERVER_URL

andrew-opensignlabs commented 1 week ago

@PereProteus The application should be strictly accessed from port number 3001 when you are accessing it from localhost. The serverurl from env variables is for internal use by the application. If you are configuring OpenSign for use on a subdomain it should automatically configure the ssl certificate & be available on port 443.

Please create a PR with your documentation change suggestions on the feat-docs branch. We’ll be happy to review the submission and integrate the changes if we find them valuable.