Skip to content

docs: [WIP] add npmx deployment instructions for self hosting #1160

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.

Sign up for GitHub

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

Draft
serhalp wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: [WIP] add npmx deployment instructions for self hosting #1160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions DEPLOY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Deploy your own npmx

The npmx community operates a public instance at [npmx.dev](https://npmx.dev), but is designed to be open and self-hostable by anyone [on any platform that supports Nuxt](https://nuxt.com/deploy).

To deploy your own instance, follow the steps below for your deployment target.

> [!TIP]
> This page is under construction. More deployment targets are coming soon.

<!-- NOTE: Please list targets alphabetically to remain neutral. -->

## Netlify

1. [Follow the Netlify instructions to import an existing GitHub project](https://docs.netlify.com/start/quickstarts/deploy-from-repository/), selecting https://github.com/npmx-dev/npmx.dev/ when prompted.
2. Generate a long, random key and set it as an environment variable in your new project called `SESSION_PASSWORD`.
3. TODO something something Upstash creds?
4. Run `pnpm remove @vercel/kv && pnpm add @netlify/blobs`
5. Commit and push this change. This will trigger a successful deploy.
6. TODO anything else?

## Vercel

1. [Follow the Vercel instructions to import an existing GitHub project](https://vercel.com/docs/getting-started-with-vercel/import), selecting https://github.com/npmx-dev/npmx.dev/ when prompted.
2. Generate a long, random key and set it as an environment variable in your new project called `SESSION_PASSWORD`.
3. TODO something something Upstash creds?
4. TODO anything else?
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,12 @@ npmx.dev also supports shorter, cleaner URLs:
- [nuxt-og-image](https://github.com/nuxt-modules/og-image)
- [npm Registry API](https://github.com/npm/registry/blob/main/docs/REGISTRY-API.md)

## Deploy your own npmx instance

The npmx community operates a public instance at [npmx.dev](https://npmx.dev), but is designed to be open and self-hostable by anyone [on any platform that supports Nuxt](https://nuxt.com/deploy).

To deploy your own instance, follow the instructions in [DEPLOY.md](./DEPLOY.md).

## Contributing

We welcome contributions &ndash; please do feel free to explore the project and improve things. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get up and running!
Expand Down
Loading