Feature/self hosters deployment #7458

iitzIrFan · 2025-03-26T15:22:30Z

What is it?

Resolves :- #5412

Feature / enhancement
Docs / tests / types / typos

Description

For a long time this issue was pending and thought of resolving it as per my best.
So I had created a new doc section, where I had mentioned about the following things,

Prerequisites,
Build options,
methods of deployment, server config,
CSRF protection guidelines & some practices

Checklist

My code follows the developer guidelines of this project
I performed a self-review of my own code
I added a changeset with pnpm change
I made corresponding changes to the Qwik docs
I added new tests to cover the fix / functionality

changeset-bot · 2025-03-26T15:22:35Z

⚠️ No Changeset found

Latest commit: e08047e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

pkg-pr-new · 2025-03-26T15:44:51Z

Open in Stackblitz

npm i https://pkg.pr.new/@builder.io/qwik@7458

npm i https://pkg.pr.new/@builder.io/qwik-city@7458

npm i https://pkg.pr.new/eslint-plugin-qwik@7458

npm i https://pkg.pr.new/create-qwik@7458

commit: 93d66e0

github-actions · 2025-03-26T15:45:12Z

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name	Status	Preview	Last Commit
qwik-docs	✅ Ready (View Log)	Visit Preview	`93d66e0`

wmertens

Looking great! But some comments

packages/docs/src/routes/api/qwik/index.md

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

wmertens · 2025-04-25T10:46:34Z

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

+<PackageManagerTabs>
+<span q:slot="pnpm">
+```shell
+pnpm run qwik add express


all these commands should just be replaced with a single npx qwik add express

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

wmertens · 2025-04-25T10:51:49Z

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

+    }
+
+    # Cache settings for immutable assets
+    location /build/ {


still needs /assets handling here, and nginx also has gzip_static on; brotli_static on;

wmertens · 2025-04-25T10:52:07Z

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

+    ProxyPassReverse / http://localhost:3000/
+
+    # Serve static assets directly
+    <Directory /path/to/your/app/dist/build>


wmertens · 2025-04-25T10:52:39Z

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

+   - Use logging services like Winston or Pino for structured logs
+
+3. Consider adding application monitoring with:
+   - Prometheus + Grafana for self-hosted monitoring


there's also netdata which is really nice

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

wmertens · 2025-04-25T10:56:53Z

packages/docs/package.json

just leave these package.json changes for another PR. Keep only the docs change

…loyment methods

iitzIrFan · 2025-04-28T19:54:33Z

@wmertens Had made changes you can review my pr and update !

iitzIrFan · 2025-04-28T21:28:06Z

@wmertens I was wondering how other developers are tackling this issue as I had encountered in development and had to figure out other ways to test before pushing my code 😕

wmertens · 2025-05-06T11:43:28Z

packages/docs/src/routes/api/qwik/index.md

@@ -3657,7 +3657,7 @@ Options for the prefetch service worker.
 </tbody></table>
 **Returns:**

-[JSXNode](#jsxnode)&lt;'script'&gt;
+JSXNode&lt;'script'&gt;


could you run pnpm api.update again please?

@wmertens
This gives an error
`,"PS C:\asus irfan\Downloads\Qwik\qwik> pnpm api.update

[email protected] api.update C:\asus irfan\Downloads\Qwik\qwik
tsx --require ./scripts/runBefore.ts scripts/index.ts --tsc --api --dev

🌎 Qwik v1.12.1-dev+e08047e [node v20.19.1, win32/x64]
tsc qwik
packages/qwik/src/optimizer/src/plugins/eslint-plugin.ts:25:9 - error TS2353: Object literal may only specify known properties, and 'root' does not exist in type 'Config | Config[]'.

25 root: true,
~~~~
node_modules/.pnpm/[email protected][email protected]/node_modules/eslint/lib/types/index.d.ts:1966:3
1966 overrideConfig?: Linter.Config | Linter.Config[] | null | undefined;
~~~~~~~~~~~~~~
The expected type comes from property 'overrideConfig' which is declared here on type 'Options'

Found 1 error in packages/qwik/src/optimizer/src/plugins/eslint-plugin.ts:25

❌ Error: Command failed with exit code 2: tsc -p C:\asus irfan\Downloads\Qwik\qwik\packages\qwik\tsconfig.json
at makeError (file:///C:/asus%20irfan/Downloads/Qwik/qwik/node_modules/.pnpm/[email protected]/node_modules/execa/lib/error.js:60:11)
at handlePromise (file:///C:/asus%20irfan/Downloads/Qwik/qwik/node_modules/.pnpm/[email protected]/node_modules/execa/index.js:124:26)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async tscQwik (C:\asus irfan\Downloads\Qwik\qwik\scripts\tsc.ts:8:18)
at async build (C:\asus irfan\Downloads\Qwik\qwik\scripts\build.ts:63:7)
Error: Error: Command failed with exit code 2: tsc -p C:\asus irfan\Downloads\Qwik\qwik\packages\qwik\tsconfig.json
at makeError (file:///C:/asus%20irfan/Downloads/Qwik/qwik/node_modules/.pnpm/[email protected]/node_modules/execa/lib/error.js:60:11)
at handlePromise (file:///C:/asus%20irfan/Downloads/Qwik/qwik/node_modules/.pnpm/[email protected]/node_modules/execa/index.js:124:26)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async tscQwik (C:\asus irfan\Downloads\Qwik\qwik\scripts\tsc.ts:8:18)
at async build (C:\asus irfan\Downloads\Qwik\qwik\scripts\build.ts:63:7)
at panic (C:\asus irfan\Downloads\Qwik\qwik\scripts\util.ts:287:33)
at build (C:\asus irfan\Downloads\Qwik\qwik\scripts\build.ts:192:5)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
ELIFECYCLE Command failed with exit code 1."`

wmertens · 2025-05-06T11:47:03Z

we're fixing the builder content issue, but you can always go directly to /docs

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx

pnpm-lock.yaml

This reverts commit 4864d0e.

iitzIrFan added 3 commits March 26, 2025 15:32

Created a new documentation section of deployment for self-hosters

0d50dd6

fixes

3d91ba7

fixes

93d66e0

iitzIrFan requested review from a team as code owners March 26, 2025 15:22

iitzIrFan mentioned this pull request Mar 26, 2025

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

Open

wmertens requested changes Apr 25, 2025

View reviewed changes

iitzIrFan and others added 14 commits April 28, 2025 16:15

docs: update contributors for self-hosting guide

0855156

docs: update self-hosting guide with streamlined commands and new dep…

b4ea1fb

…loyment methods

Update package.json

917f514

Update package.json

95a21f2

Update package.json

dac3f90

Update package.json

8d3cee7

Update package.json

045d191

Update package.json

000ece8

Update package.json

66e6dea

Update package.json

67f9f84

Update package.json

3fd6b64

Update package.json

abb12d9

Update package.json

4752802

Update package.json

5d81ed6

iitzIrFan requested a review from wmertens April 28, 2025 19:54

wmertens requested changes May 6, 2025

View reviewed changes

wmertens reviewed May 6, 2025

View reviewed changes

packages/docs/src/routes/docs/deployments/self-hosting/index.mdx Outdated Show resolved Hide resolved

wmertens reviewed May 6, 2025

View reviewed changes

pnpm-lock.yaml Outdated Show resolved Hide resolved

iitzIrFan and others added 8 commits May 8, 2025 14:22

Optimize asset compression process for parallel execution

c599e44

Update

4864d0e

Revert "Update"

8758404

This reverts commit 4864d0e.

Update pnpm-lock.yaml

4d1dc12

Update pnpm-lock.yaml

e79fa54

Update pnpm-lock.yaml

5fe5cc1

Update pnpm-lock.yaml

a14be31

Update pnpm-lock.yaml

e08047e

iitzIrFan requested a review from wmertens May 8, 2025 09:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/self hosters deployment #7458

Feature/self hosters deployment #7458

iitzIrFan commented Mar 26, 2025

changeset-bot bot commented Mar 26, 2025 •

edited

Loading

pkg-pr-new bot commented Mar 26, 2025

github-actions bot commented Mar 26, 2025 •

edited

Loading

wmertens left a comment

wmertens Apr 25, 2025

wmertens Apr 25, 2025

wmertens May 6, 2025 •

edited

Loading

wmertens Apr 25, 2025

wmertens Apr 25, 2025

wmertens Apr 25, 2025

iitzIrFan commented Apr 28, 2025

iitzIrFan commented Apr 28, 2025

wmertens May 6, 2025

iitzIrFan May 8, 2025 •

edited

Loading

wmertens commented May 6, 2025

Feature/self hosters deployment #7458

Are you sure you want to change the base?

Feature/self hosters deployment #7458

Conversation

iitzIrFan commented Mar 26, 2025

What is it?

Description

Checklist

changeset-bot bot commented Mar 26, 2025 • edited Loading

⚠️ No Changeset found

pkg-pr-new bot commented Mar 26, 2025

github-actions bot commented Mar 26, 2025 • edited Loading

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

wmertens left a comment

Choose a reason for hiding this comment

wmertens Apr 25, 2025

Choose a reason for hiding this comment

wmertens Apr 25, 2025

Choose a reason for hiding this comment

wmertens May 6, 2025 • edited Loading

Choose a reason for hiding this comment

wmertens Apr 25, 2025

Choose a reason for hiding this comment

wmertens Apr 25, 2025

Choose a reason for hiding this comment

wmertens Apr 25, 2025

Choose a reason for hiding this comment

iitzIrFan commented Apr 28, 2025

iitzIrFan commented Apr 28, 2025

wmertens May 6, 2025

Choose a reason for hiding this comment

iitzIrFan May 8, 2025 • edited Loading

Choose a reason for hiding this comment

wmertens commented May 6, 2025

changeset-bot bot commented Mar 26, 2025 •

edited

Loading

github-actions bot commented Mar 26, 2025 •

edited

Loading

wmertens May 6, 2025 •

edited

Loading

iitzIrFan May 8, 2025 •

edited

Loading