{"id":19383874,"url":"https://github.com/docspring/docspring_helm_chart","last_synced_at":"2026-03-04T04:31:01.371Z","repository":{"id":258078605,"uuid":"863853929","full_name":"DocSpring/docspring_helm_chart","owner":"DocSpring","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-16T02:31:23.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-01T00:53:30.375Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Smarty","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DocSpring.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-27T03:25:15.000Z","updated_at":"2024-10-16T02:31:26.000Z","dependencies_parsed_at":"2024-10-18T04:48:10.411Z","dependency_job_id":null,"html_url":"https://github.com/DocSpring/docspring_helm_chart","commit_stats":null,"previous_names":["docspring/docspring_helm_chart"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DocSpring/docspring_helm_chart","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring_helm_chart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring_helm_chart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring_helm_chart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring_helm_chart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/docspring_helm_chart/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring_helm_chart/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30071687,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T03:25:38.285Z","status":"ssl_error","status_checked_at":"2026-03-04T03:25:05.086Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T09:28:13.375Z","updated_at":"2026-03-04T04:31:01.304Z","avatar_url":"https://github.com/DocSpring.png","language":"Smarty","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Helm Chart for DocSpring Enterprise\n\nThis repository contains a Helm chart for deploying DocSpring Enterprise in a Kubernetes cluster.\n\n# Setup\n\n### Clone the Helm Chart Repo\n\n```\ngit clone https://github.com/DocSpring/docspring_helm_chart.git\ncd docspring_helm_chart\n```\n\n### Copy `values.example.yaml` to `values.yaml`\n\n```\ncp values.example.yaml values.yaml\n```\n\n### Create Docker Hub Authentication Secret\n\n```\nkubectl create secret docker-registry dockerhub-secret \\\n  --docker-server=https://index.docker.io/v1/ \\\n  --docker-username=\"\u003cyour-username\u003e\" \\\n  --docker-password=\"\u003cyour-password\u003e\" \\\n  --docker-email=\"\u003cyour-email\u003e\"\n```\n\n### Verify DockerHub credentials and Ensure Application Can Boot\n\n```\n./run_command.sh ./bin/smoke_test\n```\n\n### Generate Secrets\n\n```\n# Generate secret for SECRET_KEY_BASE\nopenssl rand -hex 64\n\n# Generate secret for SUBMISSION_DATA_ENCRYPTION_KEY\nopenssl rand -hex 32\n```\n\nSet these environment variables in the `sharedEnv` section in `values.yaml`.\n\n### Configure Other Environment Variables\n\nUpdate the other environment variables for `sharedEnv`, and for the `web` and `worker` services in `values.yaml`.\n\n* Set `DOMAIN_NAME` to the hostname where the application will be accessible.\n* Set `DATABASE_URL` to your Postgres connection string\n* Set `REDIS_URL` to your Redis connection string\n\nYou will also need to configure a file storage service such as AWS S3, Google Cloud Storage, or MinIO.\n\n### Install the Helm Chart\n\n```\nhelm install docspring-enterprise . --values values.yaml\n```\n\n### Check Pod Status\n\n```\nkubectl get pods -A\n```\n\n### Set Up Database\n\n```\n./run_command.sh rake db:prepare\n```\n\n### Set up SSL\n\nWe have not included configuration for `cert-manager` in this Helm chart.\nYou can use `cert-manager` to set up SSL for your domain.\n\n# Upgrade\n\n```\nhelm upgrade docspring-enterprise . --values values.yaml\n```\n\n# Uninstall\n\n```\nhelm uninstall docspring-enterprise\n```\n\n# Development\n\n* Check Helm chart for errors: `helm lint`\n* Inspect generated manifests: `helm template . --values values.yaml`\n* Validate with Kubernetes dry run: `helm template . --values values.yaml | kubectl apply --dry-run=client -f -`\n* Use `--force` flag to update helm chart while testing: `helm upgrade --force docspring-enterprise . --values values.yaml`\n\n### Access the web service locally\n\nAdd this entry to `/etc/hosts`:\n\n```\n127.0.0.1     docspring-enterprise.localhost\n```\n\nUpdate `values.yaml`:\n\n* Comment out `FORCE_SSL: \"true\"` (we have not configured SSL locally.)\n* Set `PUBLIC_PORT` to `4001`\n\nThen upgrade the Helm chart.\n\nUse `kubectl port-forward` to access the service locally:\n\n```\nkubectl port-forward svc/docspring-enterprise 4001:4001\n```\n\nCheck that everything is working:\n\n```\ncurl http://docspring-enterprise.localhost:4001/health\n```\n\nThen visit `http://docspring-enterprise.localhost:4001` in your browser.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring_helm_chart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fdocspring_helm_chart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring_helm_chart/lists"}