v1.0.0

Author: jkyberneees

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+custom: https://www.paypal.me/kyberneees

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**  
+A clear and concise description of what the bug is.
+
+**To Reproduce**  
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**  
+A clear and concise description of what you expected to happen.
+
+**Screenshots**  
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**  
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**  
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**  
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Have you contributed with at least a little donation to support the development of this project?**
+- Paypal: https://www.paypal.me/kyberneees
+- [TRON](https://www.binance.com/en/buy-TRON) Wallet: `TJ5Bbf9v4kpptnRsePXYDvnYcYrS5Tyxus`
+
+**Is your feature request related to a problem? Please describe.**  
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**  
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**  
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**  
+Add any other context or screenshots about the feature request here.

.github/workflows/build_images.yaml

@@ -0,0 +1,62 @@
+---
+name: 'build images'
+
+on:
+  release:
+    types: [published]
+  push:
+    branches:
+      - master
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Prepare
+        id: prep
+        run: |
+          DOCKER_IMAGE=${{ secrets.DOCKER_USERNAME }}/${GITHUB_REPOSITORY#*/}
+          VERSION=latest
+          # SHORTREF=${GITHUB_SHA::8}
+
+          # If this is git tag, use the tag name as a docker tag
+          if [[ $GITHUB_REF == refs/tags/* ]]; 
+          then
+            VERSION=${GITHUB_REF#refs/tags/v}
+            TAGS="${DOCKER_IMAGE}:${VERSION}-alpine"
+          else
+            TAGS="${DOCKER_IMAGE}:latest"
+          fi
+
+          # Set output parameters.
+          echo ::set-output name=tags::${TAGS}
+          echo ::set-output name=docker_image::${DOCKER_IMAGE}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@master
+        with:
+          platforms: all
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@master
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build
+        uses: docker/build-push-action@v2
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64,linux/ppc64le
+          push: true
+          tags: ${{ steps.prep.outputs.tags }}

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:16-alpine 
+RUN apk add --no-cache tini
+
+RUN mkdir /rproxy
+WORKDIR /rproxy
+
+COPY package.json .
+COPY index.js .
+COPY src ./src
+
+RUN npm install --production
+
+ENTRYPOINT ["/sbin/tini", "--"]
+CMD ["node", "index.js"]

README.md

@@ -1,2 +1,47 @@
 # rproxy
-HTTP reverse proxy implementation based on Node.js and Docker
+HTTP reverse proxy implementation based on Node.js and Docker. 
+
+`rproxy` is based on `fast-gateway` and is a ready to use Docker container image for implementing reverse proxies or API Gateways.
+> See: https://github.com/BackendStack21/fast-gateway
+
+
+## Usage
+
+### config.js
+```js
+module.exports = {
+
+  middlewares: [
+    require('cors')()
+  ],
+
+  routes: [{
+    prefix: '/api',
+    target: 'https://httpbin.org'
+  }]
+
+}
+```
+
+### Dockerfile
+```Dockerfile
+FROM kyberneees/rproxy:latest
+COPY config.js ./src
+```
+
+## Configuration
+### Environment values
+- `PORT`: Indicates the running port of the HTTP server. Defaults to: `8080`
+
+### Installing custom NPM modules
+In order to use custom NPM modules, those have to be installed through your `Dockerfile`. For example:
+
+```Dockerfile
+FROM kyberneees/rproxy:latest
+
+RUN npm i morgan 
+```
+
+Modules installed by default:
+- cors: https://www.npmjs.com/package/cors
+- http-cache-middleware: https://www.npmjs.com/package/http-cache-middleware 

index.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const gateway = require('fast-gateway')
+const PORT = process.env.PORT || 8080
+
+const proxy = gateway(require('./src/config'))
+proxy.start(PORT).then(() => {
+  console.log(`Proxy server listening on port ${PORT}`)
+})