Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/conradludgate/terraform-provider-spotify
Terraform provider for spotify
https://github.com/conradludgate/terraform-provider-spotify
spotify terraform
Last synced: about 13 hours ago
JSON representation
Terraform provider for spotify
- Host: GitHub
- URL: https://github.com/conradludgate/terraform-provider-spotify
- Owner: conradludgate
- License: mit
- Created: 2020-07-26T07:46:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-28T09:02:14.000Z (10 months ago)
- Last Synced: 2025-01-04T03:07:55.842Z (8 days ago)
- Topics: spotify, terraform
- Language: Go
- Homepage: https://registry.terraform.io/providers/conradludgate/spotify/latest
- Size: 1.61 MB
- Stars: 496
- Watchers: 8
- Forks: 42
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - conradludgate/terraform-provider-spotify - Terraform provider for spotify (Go)
- stars - conradludgate/terraform-provider-spotify - Terraform provider for spotify \[*MIT License*\] (⭐️496) (Go)
- stars - conradludgate/terraform-provider-spotify - Terraform provider for spotify \[*MIT License*\] (⭐️495) (Go)
README
# terraform-provider-spotify
[](https://registry.terraform.io/providers/conradludgate/spotify/latest/docs)
].attributes.version&url=https%3A%2F%2Fregistry.terraform.io%2Fv2%2Fproviders%2F1325%2Fprovider-versions&style=for-the-badge&color=orange&logo=terraform)
[](https://app.codecov.io/gh/conradludgate/terraform-provider-spotify/)
This is a terraform provider for managing your spotify playlists.
Featured tutorial - https://learn.hashicorp.com/tutorials/terraform/spotify-playlist
Featured interview - https://www.hashicorp.com/blog/build-your-summer-spotify-playlist-with-terraform
> I am not affiliated with Hashicorp or Terraform.
>
> If you are having trouble with the provider, try updating to the latest version
> before submitting a bug report
## Example
```tf
resource "spotify_playlist" "playlist" {
name = "My playlist"
description = "My playlist is so awesome"
public = false
tracks = flatten([
data.spotify_track.overkill.id,
data.spotify_track.blackwater.id,
data.spotify_track.overkill.id,
data.spotify_search_track.search.tracks[*].id,
])
}
data "spotify_track" "overkill" {
url = "https://open.spotify.com/track/4XdaaDFE881SlIaz31pTAG"
}
data "spotify_track" "blackwater" {
spotify_id = "4lE6N1E0L8CssgKEUCgdbA"
}
data "spotify_search_track" "search" {
name = "Somebody Told Me"
artist = "The Killers"
album = "Hot Fuss"
}
output "test" {
value = data.spotify_search_track.search.tracks
}
```
## Installation
Add the following to your terraform configuration
```tf
terraform {
required_providers {
spotify = {
source = "conradludgate/spotify"
version = "~> 0.2.0"
}
}
}
```
## How to use
First, you need an instance of a spotify oauth2 server running. This acts as a middleware between terraform and spotify to allow easy access to access tokens.
### Public proxy
For a simple way to manage your spotify oauth2 tokens is to use https://oauth2.conrad.cafe. ([source code](https://github.com/conradludgate/oauth2-proxy))
Register a new account, create a spotify token with the following scopes
* user-read-email
* user-read-private
* playlist-read-private
* playlist-modify-private
* playlist-modify-public
* user-library-read
* user-library-modify
Then take note of the token id in the URL and the API key that is shown on the page
Configure the terraform provider like so
```tf
provider "spotify" {
auth_server = "https://oauth2.conrad.cafe"
api_key = var.spotify_api_key
username = "your username"
token_id = "your token id"
}
variable "spotify_api_key" {
type = string
}
```
### Self hosted
If you want a bit more control over your tokens, you can self host a simple instance of the oauth2 proxy designed specifically for this terraform provider
See [spotify_auth_proxy](/spotify_auth_proxy) to get started.
Once you have the server running, make note of the API Key it gives you.
Configure the terraform provider like so
```tf
variable "spotify_api_key" {
type = string
}
provider "spotify" {
api_key = var.spotify_api_key
}
```