https://github.com/mashiike/nowpaste
nowpaste is slack post gatetway
https://github.com/mashiike/nowpaste
Last synced: 29 days ago
JSON representation
nowpaste is slack post gatetway
- Host: GitHub
- URL: https://github.com/mashiike/nowpaste
- Owner: mashiike
- License: mit
- Created: 2022-07-06T09:10:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T20:10:31.000Z (4 months ago)
- Last Synced: 2025-04-30T07:05:00.762Z (29 days ago)
- Language: Go
- Size: 181 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nowpaste
[](https://godoc.org/github.com/mashiike/nowpaste)
[](https://github.com/mashiike/nowpaste/blob/master/LICENSE)
nowpaste is a http server for posting messages to slack
## Install
### Binary packages
[Releases](https://github.com/mashiike/nowpaste/releases)
### as AWS Lambda function
The build binary runs as a bootstrap for AWS Lambda functions.
Rename the downloaded binary to `bootstarap` and create a zip archive. Deploy it as a Lambda function!
If a secret named `nowpaste/SLACK_TOKEN` is managed in AWS Secrets Manager and the appropriate access rights have been granted to the IAM Role, the Slack token can be passed by specifying the environment variable as follows
```
$ export NOWPASTE_SSM_NAMES=/aws/reference/secretsmanager/nowpaste/SLACK_TOKEN
```
For more information: prese refer to [lambda directory](lambda/)
### slack token permissions
It is assumed that nowpaste is passed the bot token of the slack app.
An example of a slack app manifest is shown below.
```yaml
display_information:
name: nowpaste
description: http server for posting messages to slack
background_color: "#0b50e3"
features:
bot_user:
display_name: nowpaste
always_online: true
oauth_config:
scopes:
bot:
- channels:join
- chat:write
- chat:write.public
- chat:write.customize
- files:write
settings:
org_deploy_enabled: false
socket_mode_enabled: false
token_rotation_enabled: false
```
## Usage
If you want to run locally, you can use the following options
```
nowpaste [options]
version: current
-listen string
http server run on (default ":8080")
-log-level string
log level (default "info")
-path-prefix string
endpoint path prefix (default "/")
-slack-token string
slack token
```
nowpaste runs http server on `http://#{listen}/`
If you are using a Lambda Function URL, it will be `https://.lambda-url..on.aws/`.
The simplest use case would be as follows
payload.json
```json
{
"channel": "",
"icon_emoji": ":tada:",
"username": "nowpaste",
"text": "Hello world!!"
}
```
```shell
$ cat payload.json | curl "https://.lambda-url..on.aws/" \
-X POST \
-H "Content-type: application/json" \
-d @-
```
## Amazon SNS http endpoint
nowpaste can accept Amazon SNS notification messages.
Add a SNS topic http(s) endpoint to `https://.lambda-url..on.aws/amazon-sns/{channel_id}`
## Query Parameters/Amazon SNS Message Attribuites for Message Formatting
nowpaste allows you to control the format of the message using either query parameters or Amazon SNS Message Attributes. You can switch the format of the message by adding the following parameters to the URL or setting them as SNS Message Attributes:
- `as_file`: If this parameter is set, the message is posted as a file. Valid values are `true` or `false`. The default is `false`.
- `as_message`: If this parameter is set, the message is posted as a regular text message. Valid values are `true` or `false`. The default is `true`.
For example, to post the message as a file, specify the URL as follows:
```shell
$ cat payload.json | curl "https://.lambda-url..on.aws/?as_file=true" \
-X POST \
-H "Content-type: application/json" \
-d @-
```
This URL will post the message as a file.
```shell
$ aws sns publish --topic-arn --message "Hello world!!" --message-attributes '{"as_file": {"DataType": "String", "StringValue": "true"}}'
```
This SNS message will post the message as a file.
If neither `as_file` nor `as_message` is specified, the message will be automatically posted as a file if it exceeds 4000 characters or 6 lines.
## LICENSE
MIT License
Copyright (c) 2022 IKEDA Masashi