- SSL Support (HTTPS by default)
- Automatically Renews Expired Certificates
- Configurable
bun install -d @stacksjs/tlsx
# or, invoke immediately
bunx @stacksjs/tlsx
npx @stacksjs/tlsxPlease note, we are looking to publish this package to npm under the name tlsx. Hoping npm will release the name for us.
Alternatively, you can install:
brew install tlsx # wip
pkgx install tlsx # wipThere are two ways of using this reverse proxy: as a library or as a CLI.
Given the npm package is installed:
import { config, generateCert, addCertToSystemTrustStoreAndSaveCerts, storeCert, tls, pki, forge } from '@stacksjs/tlsx'
import type { AddCertOptions, CertOptions, TlsConfig, TlsOptions } from '@stacksjs/tlsx'
// ...# more docs incoming
tlsx --help
tlsx versionThe Reverse Proxy can be configured using a tls.config.ts (or tls.config.js) file and it will be automatically loaded when running the tlsx command.
// tlsx.config.ts (or tlsx.config.js)
import type { TlsConfig } from './src/types'
export default {
ssl: {
altNameIPs: ['127.0.0.1'],
altNameURIs: ['localhost'],
organizationName: 'tlsx stacks.localhost',
countryName: 'US',
stateName: 'California',
localityName: 'Playa Vista',
commonName: 'stacks.localhost',
validityDays: 1,
},
} satisfies TlsConfigThen run:
tlsxTo learn more, head over to the documentation.
bun testPlease see our releases page for more information on what has changed recently.
Please review the Contributing Guide for details.
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
For casual chit-chat with others using this package:
Join the Stacks Discord Server
Two things are true: Stacks OSS will always stay open-source, and we do love to receive postcards from wherever Stacks is used! 🌍 We also publish them on our website.
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙