Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jackcuthbert/slack-fm
A tiny self-hosted service that automatically updates your Slack status from your Last.fm profile.
https://github.com/jackcuthbert/slack-fm
lastfm-api music self-hosted slack-api status-updates
Last synced: about 2 months ago
JSON representation
A tiny self-hosted service that automatically updates your Slack status from your Last.fm profile.
- Host: GitHub
- URL: https://github.com/jackcuthbert/slack-fm
- Owner: JackCuthbert
- License: mit
- Created: 2019-11-08T08:27:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-03T19:28:33.000Z (over 3 years ago)
- Last Synced: 2024-10-11T04:11:55.864Z (2 months ago)
- Topics: lastfm-api, music, self-hosted, slack-api, status-updates
- Language: TypeScript
- Homepage:
- Size: 2.36 MB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 27
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## Introduction
**Slack-fm** is a tiny self-hosted service that automatically updates your Slack
status from your Last.fm profile. It updates your Slack status when all the
following conditions are met:
* the user is not set to "away"
* a custom status hasn't been set
* something is now playing on Last.fm
* the time is between 9am and 5pm (configurable)
* it's not a weekend (configurable)
To clear the status it will search Last.fm for the now playing tracks duration
and use that as the status expiration time. If there is no duration information
it defaults to a 10 minute expiration (configurable).
It looks like this:
## Prerequisites
1. Last.fm API key ([get one here](https://www.last.fm/api/account/create))
1. Last.fm username (this is probably your own username!)
1. Slack "legacy" token ([get one here](https://api.slack.com/custom-integrations/legacy-tokens))
## Configuration
All configuration is available via environment variables. Values _without_ defaults are required.
Variable | Default | Description
---------|---------|------
`LAST_FM_KEY` | | Access to Last.fm data
`LAST_FM_USERNAME` | | Which user to get track info for
`SLACK_TOKEN` | | Personal "legacy" token for updating your Slack status
`SLACK_EMOJI` | `:headphones:` | Specify which emoji to use in the status
`SLACK_SEPARATOR` | `•` | Specify which character to use as a separator between the track name and artist
`TZ` | `UTC` | Set the timezone
`ACTIVE_HOURS_START` | `8` | The hour of the day to start updating your Slack status
`ACTIVE_HOURS_END` | `18` | The hour of the day to stop updating your Slack status
`UPDATE_INTERVAL` | `1` | The time in minutes to wait until updating your Slack Status
`UPDATE_WEEKENDS` | `undefined` | Provide any value to enable status updates during the weekend
`UPDATE_EXPIRATION` | `10` | The time in minutes to use as a default status expiration length
`SENTRY_DSN` | `undefined` | Optionally provide a Sentry DSN to enable error reporting
`ENABLE_LOGGING` | `undefined` | Enable verbose console output
## Hosting
I designed this to be easily self hosted, just use the Docker image! It's
automatically built and versioned on [Docker Hub](https://hub.docker.com/repository/docker/jckcthbrt/slack-fm/tags) based on GitHub activity.
### Docker run
```bash
docker run \
-e SLACK_TOKEN= \
-e LAST_FM_KEY= \
-e LAST_FM_USERNAME= \
-e TZ= \
jckcthbrt/slack-fm:latest
```
### Docker compose
```yml
version: '3.7'
services:
slack_fm:
image: jckcthbrt/slack-fm:latest
container_name: slack_fm
restart: unless-stopped
environment:
TZ:
SLACK_TOKEN:
LAST_FM_KEY:
LAST_FM_USERNAME:
```
```bash
docker-compose up
```
## Contributing
This should be relatively simple to set up and run, all that's required is Node
v12 and some environment variables.
1. Fork this repository and clone your version
1. Install dependencies with `npm install`
1. Run the tests with `npm test`
1. Set up your environment variables as above ([direnv](https://direnv.net) is great for this)
1. Start the app locally with `npm start`
1. Commit and push your changes then submit a PR back to this repository