Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keenwon/koa-subdomain
Simple and lightweight Koa middleware to handle multilevel and wildcard subdomains
https://github.com/keenwon/koa-subdomain
koa koa-middleware koajs router subdomain
Last synced: 3 months ago
JSON representation
Simple and lightweight Koa middleware to handle multilevel and wildcard subdomains
- Host: GitHub
- URL: https://github.com/keenwon/koa-subdomain
- Owner: keenwon
- License: mit
- Created: 2016-05-17T10:45:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T02:49:00.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T22:47:15.281Z (10 months ago)
- Topics: koa, koa-middleware, koajs, router, subdomain
- Language: JavaScript
- Size: 1.57 MB
- Stars: 23
- Watchers: 3
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-subdomain
[![NPM version][npm-image]][npm-url]
[![Node version][node-image]][node-url]
[![Build Status][github-actions-image]][github-actions-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![npm download][download-image]][download-url]
[![Dependencies Status][dependencies-image]][dependencies-url]
[![Devdependencies Status][devdependencies-image]][devdependencies-url]
Simple and lightweight Koa middleware to handle multilevel and wildcard subdomains.
## Installation
Install using npm:
```shell
npm install koa-subdomain --save
```
[](https://npmjs.org/package/koa-subdomain)
## Usage
use with [koa-router](https://github.com/alexmingoia/koa-router):
```javascript
const Koa = require('koa');
const Subdomain = require('koa-subdomain');
const Router = require('koa-router');
const app = new Koa();
const subdomain = new Subdomain();
const router = new Router();
router.get('/', async ctx => {
ctx.body = 'one';
});
// one.example.com
subdomain.use('one', router.routes());
app.use(subdomain.routes());
app.listen(8888);
```
more example:
```javascript
const app = require('koa')();
const subdomain = require('koa-subdomain')();
// one.example.com
subdomain.use('one', router1);
// two.example.com
subdomain.use('two', router2);
subdomain
.use('a.one', router3) // a.one.example.com
.use('b.one', router4); // b.one.example.com
// example.com
subdomain.use('', router5);
// *.example.com
subdomain.use('*', router6);
// *.one.example.com
subdomain.use('*.one', router7);
// one.*.example.com
subdomain.use('one.*', router8);
app.use(subdomain.routes());
app.listen(8888);
```
Wildcard subdomains will be accessible under `wildcardSubdomains` in the state of koa context.
```javascript
const Koa = require('koa');
const Subdomain = require('koa-subdomain');
const Router = require('koa-router');
const app = new Koa();
const subdomain = new Subdomain();
const router1 = new Router();
const router2 = new Router();
// get test.example.com
router1.get('/', async ctx => {
// in body will stand "test"
ctx.body = ctx.state.wildcardSubdomains[0];
});
// get foo.bar.example.com
router2.get('/', async ctx => {
// in body will stand "foo bar"
ctx.body = ctx.state.wildcardSubdomains.join(' ');
});
// *.example.com
subdomain.use('*', router1.routes());
subdomain.use('*.*', router2.routes());
app.use(subdomain.routes());
app.listen(8888);
```
**Note**: Koa has a `subdomainOffset` setting (2, by default), so the domain of the app is assumed to be the last two parts of the host. Here is an example when it is useful: if your app domain is `localhost:3000`, you need to change `subdomainOffset` to 1 for proper subdomain detection.
```js
const app = new Koa();
app.subdomainOffset = 1
// one.localhost:3000
subdomain.use('one', router);
```
## koa1
Install:
```shell
npm install koa-subdomain@1 --save
```
Usage:
```javascript
const app = require('koa')();
const subdomain = require('koa-subdomain')();
const router = require('koa-router')();
router.get('/', function * () {
this.body = 'one';
});
// one.example.com
subdomain.use('one', router.routes());
app.use(subdomain.routes());
app.listen(8888);
```
## Run test
```shell
git clone https://github.com/keenwon/koa-subdomain.git
cd koa-subdomain
npm install
npm test
```
[npm-image]: https://img.shields.io/npm/v/koa-subdomain.svg
[npm-url]: https://www.npmjs.com/package/koa-subdomain
[node-image]: https://img.shields.io/node/v/koa-subdomain.svg
[node-url]: https://nodejs.org
[github-actions-image]: https://github.com/keenwon/koa-subdomain/workflows/unittest/badge.svg
[github-actions-url]: https://github.com/keenwon/koa-subdomain/actions
[coveralls-image]: https://img.shields.io/codecov/c/github/keenwon/koa-subdomain
[coveralls-url]: https://codecov.io/gh/keenwon/koa-subdomain
[download-image]: https://img.shields.io/npm/dm/koa-subdomain.svg
[download-url]: https://npmjs.org/package/koa-subdomain
[dependencies-image]: https://img.shields.io/david/keenwon/koa-subdomain.svg
[dependencies-url]: https://david-dm.org/keenwon/koa-subdomain
[devdependencies-image]: https://img.shields.io/david/dev/keenwon/koa-subdomain.svg
[devdependencies-url]: https://david-dm.org/keenwon/koa-subdomain?type=dev