chore: prepare v0.1.0

CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.1.0 (Unreleased)
+## 0.1.0 (2025-02-19)
 
 ### Features
 

docs/data-sources/mycnf.md

@@ -10,7 +10,30 @@ description: |-
 
 MySQL configuration data source
 
-
+## Example Usage
+
+```terraform
+// access the .my.cnf file of the user
+data "uberspace_mycnf" "mycnf" {}
+
+output "user" {
+  value = data.uberspace_mycnf.mycnf.client.user
+}
+
+output "password" {
+  value     = data.uberspace_mycnf.mycnf.client.password
+  sensitive = true
+}
+
+output "ro_user" {
+  value = data.uberspace_mycnf.mycnf.clientreadonly.user
+}
+
+output "ro_password" {
+  value     = data.uberspace_mycnf.mycnf.clientreadonly.password
+  sensitive = true
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/user.md

@@ -10,7 +10,16 @@ description: |-
 
 The uberspace user
 
+## Example Usage
 
+```terraform
+// access the uberspace user
+data "uberspace_user" "user" {}
+
+output "user" {
+  value = data.uberspace_user.user.name
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/crontab_entry.md

@@ -10,7 +10,16 @@ description: |-
 
 Crontab entry
 
+## Example Usage
 
+```terraform
+data "uberspace_user" "user" {}
+
+// create a crontab entry to run a Python script every 5 minutes
+resource "uberspace_crontab_entry" "example" {
+  entry = "*/5 * * * * python /home/${data.uberspace_user.user.name}/bin/example.py"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/mysql_database.md

@@ -10,7 +10,14 @@ description: |-
 
 Manage MySQL databases.
 
+## Example Usage
 
+```terraform
+// create a new mysql database, the name will be "{username}_{suffix}", e.g. "isabell_test"
+resource "uberspace_mysql_database" "test" {
+  suffix = "test"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/remote_file.md

@@ -10,7 +10,36 @@ description: |-
 
 Manage remote files.
 
-
+## Example Usage
+
+```terraform
+// create a remote file resource with the upload of a Python script
+resource "uberspace_remote_file" "examplepy" {
+  src        = "example.py"
+  dst        = "/home/isabell/bin/example.py"
+  src_hash   = filesha256("example.py")
+  executable = true
+}
+
+// crate a remote file from a download from the internet, check its hash and make it executable
+data "http" "minio" {
+  url = "https://dl.min.io/server/minio/release/linux-amd64/minio.sha256sum"
+}
+
+resource "uberspace_remote_file" "minio" {
+  src        = "https://dl.min.io/server/minio/release/linux-amd64/minio"
+  dst        = "/home/isabell/bin/minio"
+  src_hash   = data.http.minio.response_body
+  executable = true
+}
+
+
+// create a remote file resource from a string
+resource "uberspace_remote_file" "exampletxt" {
+  content = "example content"
+  dst     = "/home/isabell/example.txt"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/supervisor_service.md

@@ -10,7 +10,26 @@ description: |-
 
 Manage supervisor services.
 
-
+## Example Usage
+
+```terraform
+resource "uberspace_supervisor_service" "app" {
+  name    = "minio"
+  command = "/home/isabell/bin/minio server /home/isabell/minio --address 0.0.0.0:9000 --console-address 0.0.0.0:9001"
+  environment = {
+    "MINIO_ACCESS_KEY"           = "minio"
+    "MINIO_SECRET_KEY"           = "minio123"
+    "MINIO_BROWSER_REDIRECT_URL" = "https://console.example.com/"
+  }
+
+  lifecycle {
+    replace_triggered_by = [
+      // Add a trigger here to restart the service when the binary changes
+      // uberspace_remote_file.minio
+    ]
+  }
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/web_backend.md

@@ -10,7 +10,21 @@ description: |-
 
 Manage web backends in web server configuration.
 
+## Example Usage
 
+```terraform
+resource "uberspace_web_domain" "minio" {
+  domain = "minio.isabell.uber.space"
+}
+
+resource "uberspace_web_backend" "minio" {
+  // a web backend usually depends on a web domain
+  depends_on = [uberspace_web_domain.minio]
+
+  uri  = "minio.isabell.uber.space/"
+  port = 9001
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/web_domain.md

@@ -10,7 +10,13 @@ description: |-
 
 Manage domains in web server configuration.
 
+## Example Usage
 
+```terraform
+resource "uberspace_web_domain" "minio" {
+  domain = "minio.isabell.uber.space"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema