{"id":17723254,"url":"https://github.com/aaronpk/aperture","last_synced_at":"2025-04-15T07:17:48.990Z","repository":{"id":42945461,"uuid":"110761194","full_name":"aaronpk/Aperture","owner":"aaronpk","description":"Aperture is a Microsub server. Currently in beta.","archived":false,"fork":false,"pushed_at":"2024-08-10T14:52:12.000Z","size":3633,"stargazers_count":69,"open_issues_count":70,"forks_count":5,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-15T07:17:42.262Z","etag":null,"topics":["indieweb","microsub","reader"],"latest_commit_sha":null,"homepage":"https://aperture.p3k.io","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aaronpk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"open_collective":"indieweb","custom":"https://aaronparecki.com/tip/"}},"created_at":"2017-11-15T00:18:03.000Z","updated_at":"2024-11-09T19:49:12.000Z","dependencies_parsed_at":"2024-08-10T16:06:32.990Z","dependency_job_id":null,"html_url":"https://github.com/aaronpk/Aperture","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/aaronpk%2FAperture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronpk%2FAperture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronpk%2FAperture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronpk%2FAperture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aaronpk","download_url":"https://codeload.github.com/aaronpk/Aperture/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249023745,"owners_count":21199961,"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":["indieweb","microsub","reader"],"created_at":"2024-10-25T15:42:21.829Z","updated_at":"2025-04-15T07:17:48.972Z","avatar_url":"https://github.com/aaronpk.png","language":"PHP","funding_links":["https://opencollective.com/indieweb","https://aaronparecki.com/tip/"],"categories":[],"sub_categories":[],"readme":"Aperture\n========\n\nAperture is a [Microsub](https://indieweb.org/Microsub) server.\n\nIt is currently in beta, and although has been pretty stable for the last several months. You can try out the hosted service at [aperture.p3k.io](https://aperture.p3k.io), which keeps data for 7 days, or you can host your own copy to customize it.\n\n\nSetup\n-----\n\nBy default, new user accounts are not created automatically. You will need to first create a user before you can log in.\n\nFrom the command line, run this command, passing your home page URL as the argument:\n\n```\nphp artisan create:user https://example.com/\n```\n\nYou will need to have a token endpoint set up already in order for Aperture to know how to verify access tokens it receives in Microsub requests. If there is no token endpoint found at that URL, user account creation will fail.\n\nYou can enable a config option to allow anyone to sign in to your instance. Set `PUBLIC_ACCESS=true` in `.env`.\n\n\nDependencies\n------------\n\nAperture relies on a few external services to work.\n\n[Watchtower](https://github.com/aaronpk/Watchtower) handles actually subscribing to feeds and delivering content to Aperture. Aperture is only responsible for parsing the content, but contains no feed polling/fetching logic.\n\nAperture uses an image proxy to rewrite all image URLs as https URLs. It expects to use a service that matches GitHub's camo API. You can use either [camo](https://github.com/atmos/camo) itself, or an API-compatible project such as [go-camo](https://github.com/cactus/go-camo). You'll need to define the base URL `IMG_PROXY_URL` and the signing secret `IMG_PROXY_KEY` in the `.env` file.\n\n\n\nCredits\n-------\n\nAperture logo by Gregor Cresnar from the Noun Project.\n\n\nLicense\n-------\n\nCopyright 2018 by Aaron parecki.\n\nAvailable under the Apache 2.0 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronpk%2Faperture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faaronpk%2Faperture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronpk%2Faperture/lists"}