Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathanielvarona/pritunl-slack-app
Pritunl Slack App Slash Commands
https://github.com/nathanielvarona/pritunl-slack-app
aws-lambda docker flask-application hacktoberfest heml kubernetes lambda-functions pritunl pritunl-server pritunl-vpn serverless slack-api slack-app slack-bolt slack-bot slackbot vpn vpn-server vpn-service
Last synced: 19 days ago
JSON representation
Pritunl Slack App Slash Commands
- Host: GitHub
- URL: https://github.com/nathanielvarona/pritunl-slack-app
- Owner: nathanielvarona
- License: mit
- Created: 2023-03-27T13:54:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-04T18:10:02.000Z (8 months ago)
- Last Synced: 2024-05-05T18:24:55.141Z (8 months ago)
- Topics: aws-lambda, docker, flask-application, hacktoberfest, heml, kubernetes, lambda-functions, pritunl, pritunl-server, pritunl-vpn, serverless, slack-api, slack-app, slack-bolt, slack-bot, slackbot, vpn, vpn-server, vpn-service
- Language: Python
- Homepage:
- Size: 736 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pritunl-slack-app
Pritunl Slack App Slash Commands
## Pritunl Slack Slash Commands Screenshot
## Installation
### Flask _(Server)_
#### Install the Flask Extras
Using Poetry
```bash
poetry install --extras=flask
```
Using PIP _(source install)_
```bash
pip install .[flask]
```
#### Development
```bash
flask run
```
#### Production
```bash
gunicorn pritunl_slack_app.flask_handler:flask_app \
--bind 0.0.0.0:9000
```
### AWS Lambda _(Serverless)_
#### Using `.zip` file archives
##### Export Poetry Dependencies to base PIP `requirements.txt`
```bash
poetry export --without-hashes \
--format requirements.txt \
--output ./pritunl_slack_app/function/requirements.txt
```
##### SAM Build
```bash
sam build --use-container
```
##### SAM Deployment
```bash
sam deploy --guided
```
> Check out the article [Build a Pritunl Slack Slash Commands with a Serverless Backend](https://nathanielvarona.github.io/posts/build-a-pritunl-slack-slash-commands-with-a-serverless-backend/) for the complete Serverless Backend deployment.
### Docker Image _(Containers)_
#### Using Flask and Gunicorn App Handlers
##### Build an Image
```bash
docker buildx build . \
--file flask-gunicorn.Dockerfile \
--progress plain \
--target production \
--tag nathanielvarona/pritunl-slack-app
```
##### Production Mode
```bash
docker run -it --rm \
--env PRITUNL_BASE_URL=https://vpn.domain.tld/ \
--env PRITUNL_API_SECRET="####" \
--env PRITUNL_API_TOKEN="####" \
--env SLACK_SIGNING_SECRET="####" \
--env SLACK_BOT_TOKEN="####" \
--env GUNICORN_CMD_ARGS="--timeout 0" \
--env APP_PORT=8081 \
--publish 8081:8081 \
nathanielvarona/pritunl-slack-app
```
##### Other Options
Example 1: Enable AsyncIO Workers by increasing the number of Gunicorn workers and threads.
```bash
docker run -it --rm \
--env PRITUNL_BASE_URL=https://vpn.domain.tld/ \
--env PRITUNL_API_SECRET="####" \
--env PRITUNL_API_TOKEN="####" \
--env SLACK_SIGNING_SECRET="####" \
--env SLACK_BOT_TOKEN="####" \
--env GUNICORN_CMD_ARGS="--timeout 0 --workers 5 --threads 2" \
--env APP_PORT=8081 \
--publish 8081:8081 \
nathanielvarona/pritunl-slack-app
```
Example 2: Enable debug mode.
```bash
docker run -it --rm \
--env PRITUNL_BASE_URL=https://vpn.domain.tld/ \
--env PRITUNL_API_SECRET="####" \
--env PRITUNL_API_TOKEN="####" \
--env SLACK_SIGNING_SECRET="####" \
--env SLACK_BOT_TOKEN="####" \
--env GUNICORN_CMD_ARGS="--timeout 0" \
--env FLASK_DEBUG=True \
--env APP_PORT=8081 \
--publish 8081:8081 \
nathanielvarona/pritunl-slack-app
```