{"id":17131300,"url":"https://github.com/dfithian/dash-s3-feed","last_synced_at":"2025-03-24T05:16:18.857Z","repository":{"id":85573492,"uuid":"98134921","full_name":"dfithian/dash-s3-feed","owner":"dfithian","description":"Proxy server of S3 that serves Dash docsets","archived":false,"fork":false,"pushed_at":"2021-11-22T15:00:23.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-29T11:11:23.005Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Haskell","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/dfithian.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":"2017-07-24T00:49:50.000Z","updated_at":"2021-03-08T03:15:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"e6aab8f8-0d26-423c-9d1d-3dd872799b8e","html_url":"https://github.com/dfithian/dash-s3-feed","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfithian%2Fdash-s3-feed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfithian%2Fdash-s3-feed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfithian%2Fdash-s3-feed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dfithian%2Fdash-s3-feed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dfithian","download_url":"https://codeload.github.com/dfithian/dash-s3-feed/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245212303,"owners_count":20578443,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-10-14T19:23:09.111Z","updated_at":"2025-03-24T05:16:18.822Z","avatar_url":"https://github.com/dfithian.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dash-s3-feed\n\nA proxy server over S3 that serves [Dash](http://kapeli.com/) docsets.\n\n## Setup\n\n* Postgres: `brew install postgres`\n* AWS Credentials in `~/.aws/credentials`\n* Migrations: `psql -d postgres -f dash-s3-feed/sql/create-tables.sql`\n* Build: `stack install`\n* Run: `cd dash-s3-feed \u0026\u0026 ~/.local/bin/dash-s3-feed`\n\n## Creating Users\n\nThere's a `create-user` binary. For help, run `create-user --help`. An example invocation:\n\n```bash\ncreate-user --username username --password password \\\n  --conn-string \"host=localhost port=5432 dbname=postgres\"\n```\n## Authentication\n\nThis uses basic authentication. Generate an SSL certificate. Some sample steps:\n\n```bash\n# Create the key\nopenssl genrsa -out dash-s3-feed-key.pem 2048\n# Create a CSR and fill out the appropriate values\nopenssl req -new -sha256 -key dash-s3-feed-key.pem -out dash-s3-feed-csr.csr\n# Generate the certificate\nopenssl req -x509 -sha256 -days 365 -key dash-s3-feed-key.pem -in dash-s3-feed-csr.csr -out dash-s3-feed-certificate.pem\n# Move key and certificate to the appropriate directory\nmv dash-s3-feed-key.pem dash-s3-feed/config/dash-s3-feed-key.pem\nmv dash-s3-feed-certificate.pem dash-s3-feed/config/dash-s3-feed-certificate.pem\n```\n\n## Getting files\n\nFor both manifests and docsets, `GET` to `/file/\u003cbucket\u003e/\u003cpath\u003e`.\n\n### Example\n\n```bash\ncurl https://user:pass@localhost:10443/file/my-bucket/my%2furlescaped%2fpath%2fmanifest.xml\n```\n\n## Pushing docsets\n\nMultipart upload with `version` (text) and `file` (.tar.gz file) inputs. `POST` to\n`/file/\u003cbucket\u003e/\u003cmanifest-path\u003e`.\n\n### Example\n\n```bash\ncurl https://user:pass@localhost:10443/file/my-bucket/my%2furlescaped%2fpath%2fmanifest.xml \\\n  -F \"version=1.0\" -F \"file=@docset.tar.gz\"\n```\n\n## Setting up a Dash feed\n\nGo to Preferences \u003e Downloads \u003e `+`. Enter the manifest url\n(`https://user:pass@server:port/file/bucket/path%2fmanifest.xml`). Click \"Download\".\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdfithian%2Fdash-s3-feed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdfithian%2Fdash-s3-feed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdfithian%2Fdash-s3-feed/lists"}