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

[📖] Provide a general deployment page for self-hosters #5412

Open
christian-hackyourshack opened this issue Nov 9, 2023 · 6 comments
Open
Labels
COMMUNITY: good first issue Good for newcomers COMMUNITY: PR is welcomed We think it's a good feature to have but would love for the community to help with the PR for it COMP: docs Improvements or additions to documentation

Comments

@christian-hackyourshack
Copy link

Suggestion

I think there are some common issues, that new users are facing, when trying to deploy a Qwik app to their own infrastructure independent of using Node, Deno or Bun. Hence, I want to suggest to merge those deployment pages together, remove the sentence "Since you are choosing [Node|Deno|Bun], here you are in your own..." and try to collect the common issues, that usually do not result from the server technology but from the hosting infrastructure.

For me it was:

  • set ORIGIN because my server runs behind a proxy handling SSL, that is currently only mentioned for Node, but not for Deno and Bun (probably not necessary for Deno Deploy, but if self-hosted)
  • default minification of HTML on the Cloudflare edge, stripping out the essential HTML comments, but there is no hint in the docs, that the comments are essential

I would love to use this issue for a discussion, potentially collecting more issues encountered by others and when considered good, I would create a PR for the docs pages.

@christian-hackyourshack christian-hackyourshack added COMP: docs Improvements or additions to documentation STATUS-1: needs triage New issue which needs to be triaged labels Nov 9, 2023
@christian-hackyourshack
Copy link
Author

I created a Discord thread for qwik discussions:
https://discord.com/channels/842438759945601056/842438761287254019/1172118644508078081

@ptz0n
Copy link
Contributor

ptz0n commented Nov 9, 2023

Thank you so much for pointing this out. I was struggling to understand why my client side routing was broken. Everything else worked fine, no errors in console or Network tab.

thank you

Here's my POC: https://github.com/ptz0n/qwik-cloudfront-s3-lambda-url

@christian-hackyourshack
Copy link
Author

One more point would be, what to put into a docker. Currently it seems, as if you need to put node_modules into the docker, too, which is not obvious and very inefficient. But I have not dockerized any other Vite-based SSR projects yet, so that might be normal.

Because I like it tidy, I would prefer a solution, where I can get a tree-shaken version for the server, too. Right now, I am uploading a 350MB docker to my server, where the biggest memory-hogs are @qwikest/icons (55MB), where I use 5 icons and typescript (40MB), which should not be required at runtime at all followed by other dependencies like prettier (9MB), esbuild (9MB), ...

@gioboa gioboa added COMMUNITY: good first issue Good for newcomers COMMUNITY: PR is welcomed We think it's a good feature to have but would love for the community to help with the PR for it and removed STATUS-1: needs triage New issue which needs to be triaged labels Jun 17, 2024
@gioboa
Copy link
Member

gioboa commented Jun 17, 2024

This cookbook described a Deploy with Node using Docker scenario. Do you think is enough? @christian-hackyourshack

@gioboa gioboa added the WAITING FOR: user Further information is requested from the issue / pr opener label Jun 17, 2024
@christian-hackyourshack
Copy link
Author

I like your cookbook and I saw, that the ORIGIN has made it into it and also into the deployment docs for node.

I still think the minification should still get a mention somewhere, because it is not really clear from the docs, how Qwik uses inline comments for its implementation. And when you integrate it into your CI/CD this might be an important detail. For Cloudflare it might be less interesting now, as they changed the default setting to not minify anymore.

@gioboa
Copy link
Member

gioboa commented Jun 17, 2024

would you like to improve that page with your suggestions? It will be great. Thanks

@gioboa gioboa added the STATUS-2: docs team is working on this This goes into the backlog of the docs team label Jun 19, 2024
@maiieul maiieul removed the WAITING FOR: user Further information is requested from the issue / pr opener label Jul 16, 2024
@maiieul maiieul removed the STATUS-2: docs team is working on this This goes into the backlog of the docs team label Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
COMMUNITY: good first issue Good for newcomers COMMUNITY: PR is welcomed We think it's a good feature to have but would love for the community to help with the PR for it COMP: docs Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

4 participants