diff --git a/charts/pixelfed/Chart.yaml b/charts/pixelfed/Chart.yaml index 18cba4b..e9c6c6f 100644 --- a/charts/pixelfed/Chart.yaml +++ b/charts/pixelfed/Chart.yaml @@ -15,8 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.1.0 +version: 0.2.0 # This is the version number of the application being deployed. -# image=ghcr.io/mattlqx/docker-pixelfed +# renovate:image=ghcr.io/mattlqx/docker-pixelfed appVersion: "v0.12.3-nginx" + +maintainers: + - name: "jessebot" + email: "jessebot@linux.com" + url: "https://github.com/jessebot" diff --git a/charts/pixelfed/README.md b/charts/pixelfed/README.md index 23aa6f9..3bf3df6 100644 --- a/charts/pixelfed/README.md +++ b/charts/pixelfed/README.md @@ -1,9 +1,15 @@ # pixelfed -![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.12.3-nginx](https://img.shields.io/badge/AppVersion-v0.12.3--nginx-informational?style=flat-square) +![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.12.3-nginx](https://img.shields.io/badge/AppVersion-v0.12.3--nginx-informational?style=flat-square) A Helm chart for deploying Pixelfed on Kubernetes +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| jessebot | | | + ## Values | Key | Type | Default | Description | @@ -30,6 +36,53 @@ A Helm chart for deploying Pixelfed on Kubernetes | livenessProbe.httpGet.port | string | `"http"` | | | nameOverride | string | `""` | This is to override the chart name. | | nodeSelector | object | `{}` | | +| pixelfed.account_deletion | bool | `true` | Enable account deletion (may be a requirement in some jurisdictions) | +| pixelfed.app.domain | string | `""` | The domain of your server, without https:// | +| pixelfed.app.env | string | `"production"` | The app environment, keep it set to "production" | +| pixelfed.app.locale | string | `"en"` | change this to the language code of your pixelfed instance | +| pixelfed.app.name | string | `"Pixelfed"` | The name of your server/instance | +| pixelfed.app.url | string | `"https://localhost"` | change this to the domain of your pixelfed instance | +| pixelfed.config_cache | bool | `true` | Enable the config cache to allow you to manage settings via the admin dashboard | +| pixelfed.enforce_email_verification | bool | `true` | Enforce email verification | +| pixelfed.force_https_urls | bool | `true` | Force https url generation | +| pixelfed.image_quality | int | `80` | Set the image optimization quality, between 1-100. Lower uses less space, higher more quality | +| pixelfed.instance.contact_email | string | `""` | The public contact email for your server | +| pixelfed.instance.contact_form | bool | `false` | enable the instance contact form | +| pixelfed.instance.cur_reg | bool | `false` | Enable Curated Registration | +| pixelfed.instance.description | string | `"Pixelfed - Photo sharing for everyone"` | your server description | +| pixelfed.instance.discover_public | bool | `false` | Enable public access to the Discover feature | +| pixelfed.instance.landing.show_directory | bool | `true` | Enable the profile directory on the landing page | +| pixelfed.instance.landing.show_explore | bool | `true` | Enable the popular post explore on the landing page | +| pixelfed.instance.post_embeds | bool | `true` | Enable the post embed feature | +| pixelfed.instance.profile_embeds | bool | `true` | Enable the profile embed feature | +| pixelfed.instance.public_hashtags | bool | `false` | Allow anonymous access to hashtag feeds | +| pixelfed.instance.reports.email_addresses | list | `[]` | A list of email addresses to deliver admin reports to | +| pixelfed.instance.reports.email_autospam | bool | `false` | Enable autospam reports (require INSTANCE_REPORTS_EMAIL_ENABLED) | +| pixelfed.instance.reports.email_enabled | bool | `false` | Send a report email to the admin account for new autospam/reports | +| pixelfed.instance.show_peers | bool | `false` | Enable the api/v1/peers API endpoint | +| pixelfed.max_account_size | int | `1000000` | The max allowed account size in KB | +| pixelfed.max_album_length | int | `6` | The max number of media per post album | +| pixelfed.max_avatar_size | int | `2000` | The max user avatar size in KB | +| pixelfed.max_bio_length | int | `256` | The max user bio length | +| pixelfed.max_caption_length | int | `1000` | The max post caption length | +| pixelfed.max_name_length | int | `32` | The max user display name length | +| pixelfed.max_photo_size | int | `15000` | The max photo/video size in KB | +| pixelfed.min_password_length | int | `16` | The min password length | +| pixelfed.oauth_enabled | bool | `true` | Enable oAuth support, required for mobile/3rd party apps | +| pixelfed.open_registration | bool | `true` | Enable open registration for new accounts | +| pixelfed.pf.admin_invites_enabled | bool | `true` | Enable the Admin Invites feature | +| pixelfed.pf.enable_cloud | bool | `false` | Enable S3/Object Storage | +| pixelfed.pf.enforce_max_users | int | `2000` | in KB | +| pixelfed.pf.hide_nsfw_on_public_feeds | bool | `false` | Hide sensitive posts from public/network feeds | +| pixelfed.pf.local_avatar_to_cloud | bool | `false` | Store local avatars on S3 (Requires S3) | +| pixelfed.pf.max_collection_length | int | `100` | Max collection post limit | +| pixelfed.pf.max_domain_blocks | int | `50` | The max number of domain blocks per account | +| pixelfed.pf.max_user_blocks | int | `50` | The max number of user blocks per account | +| pixelfed.pf.max_user_mutes | int | `50` | The max number of user mutes per account | +| pixelfed.pf.max_users | int | `1000` | Limit max user registrations | +| pixelfed.pf.optimize_images | bool | `true` | Enable image optimization | +| pixelfed.pf.optimize_videos | bool | `true` | Enable video optimization | +| pixelfed.stories_enabled | bool | `false` | Enable the Stories feature | | podAnnotations | object | `{}` | This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ | | podLabels | object | `{}` | This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ | | podSecurityContext | object | `{}` | | diff --git a/charts/pixelfed/values.yaml b/charts/pixelfed/values.yaml index 7d33b99..927c6b5 100644 --- a/charts/pixelfed/values.yaml +++ b/charts/pixelfed/values.yaml @@ -123,3 +123,127 @@ nodeSelector: {} tolerations: [] affinity: {} + +pixelfed: + # app specific settings + app: + # -- The name of your server/instance + name: "Pixelfed" + # -- The app environment, keep it set to "production" + env: "production" + # -- change this to the domain of your pixelfed instance + url: "https://localhost" + # -- change this to the language code of your pixelfed instance + locale: "en" + # -- The domain of your server, without https:// + domain: "" + + # -- Enable open registration for new accounts + open_registration: true + + # -- Enforce email verification + enforce_email_verification: true + + # -- The min password length + min_password_length: 16 + + # -- Enable account deletion (may be a requirement in some jurisdictions) + account_deletion: true + + # -- Enable oAuth support, required for mobile/3rd party apps + oauth_enabled: true + + # -- Enable the Stories feature + stories_enabled: false + + # -- Enable the config cache to allow you to manage settings via the admin dashboard + config_cache: true + + # -- Set the image optimization quality, between 1-100. Lower uses less space, higher more quality + image_quality: 80 + + # -- The max allowed account size in KB + max_account_size: 1000000 + + # -- The max photo/video size in KB + max_photo_size: 15000 + + # -- The max user avatar size in KB + max_avatar_size: 2000 + + # -- The max post caption length + max_caption_length: 1000 + + # -- The max user bio length + max_bio_length: 256 + + # -- The max user display name length + max_name_length: 32 + + # -- The max number of media per post album + max_album_length: 6 + + # -- Force https url generation + force_https_urls: true + + # your whole instance, or server, settings + instance: + # -- your server description + description: "Pixelfed - Photo sharing for everyone" + # -- enable the instance contact form + contact_form: false + # -- Enable public access to the Discover feature + discover_public: false + # -- Allow anonymous access to hashtag feeds + public_hashtags: false + # -- The public contact email for your server + contact_email: "" + # -- Enable the profile embed feature + profile_embeds: true + # -- Enable the post embed feature + post_embeds: true + # -- Enable Curated Registration + cur_reg: false + # -- Enable the api/v1/peers API endpoint + show_peers: false + + reports: + # -- Send a report email to the admin account for new autospam/reports + email_enabled: false + # -- A list of email addresses to deliver admin reports to + email_addresses: [] + # -- Enable autospam reports (require INSTANCE_REPORTS_EMAIL_ENABLED) + email_autospam: false + + landing: + # -- Enable the profile directory on the landing page + show_directory: true + # -- Enable the popular post explore on the landing page + show_explore: true + + # public feed settings + pf: + # -- Hide sensitive posts from public/network feeds + hide_nsfw_on_public_feeds: false + # -- Store local avatars on S3 (Requires S3) + local_avatar_to_cloud: false + # -- Enable the Admin Invites feature + admin_invites_enabled: true + # -- The max number of user blocks per account + max_user_blocks: 50 + # -- The max number of user mutes per account + max_user_mutes: 50 + # -- The max number of domain blocks per account + max_domain_blocks: 50 + # -- Enable S3/Object Storage + enable_cloud: false + # -- Limit max user registrations + max_users: 1000 + # -- in KB + enforce_max_users: 2000 + # -- Enable image optimization + optimize_images: true + # -- Enable video optimization + optimize_videos: true + # -- Max collection post limit + max_collection_length: 100