{"id":24529627,"url":"https://github.com/retrixe/concinnity-deploy","last_synced_at":"2025-03-15T17:47:27.255Z","repository":{"id":271883988,"uuid":"914489114","full_name":"retrixe/concinnity-deploy","owner":"retrixe","description":"Automated deployment of Concinnity to CloudFlare Pages","archived":false,"fork":false,"pushed_at":"2025-03-03T12:53:44.000Z","size":1880,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-09T19:36:31.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Svelte","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/retrixe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2025-01-09T17:39:23.000Z","updated_at":"2025-03-03T12:53:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"e83f0717-4a9f-425d-8a3a-2d704b9d1ad1","html_url":"https://github.com/retrixe/concinnity-deploy","commit_stats":null,"previous_names":["retrixe/concinnity-deploy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fconcinnity-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fconcinnity-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fconcinnity-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fconcinnity-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/retrixe","download_url":"https://codeload.github.com/retrixe/concinnity-deploy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243769949,"owners_count":20345216,"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":"2025-01-22T07:39:34.440Z","updated_at":"2025-03-15T17:47:27.246Z","avatar_url":"https://github.com/retrixe.png","language":"Svelte","funding_links":[],"categories":[],"sub_categories":[],"readme":"# concinnity\n\nWatch videos together with others on the internet.\n\n![screenshot of concinnity](https://f002.backblazeb2.com/file/retrixe-storage-public/concinnity/demo-light.jpg)\n\nThis application currently supports watching locally stored files. Support for remotely hosted files and YouTube videos is planned.\n\nIf you want to use concinnity with your friends, visit [concinnity.retrixe.xyz](https://concinnity.retrixe.xyz). Else, if you want to self-host concinnity, see the instructions below.\n\n## Quick Start\n\n- Prerequisites: You must have a PostgreSQL/MariaDB database setup, and Golang, Node.js and corepack are needed to build the application.\n- To run the backend on a server:\n  - Run `go build` in the `backend` folder to compile it.\n  - Create a `config.json` in the same folder according to the section on [backend configuration](#backend).\n  - You can now run the backend using `./concinnity` (it will run on port 8000 by default).\n- To run the frontend on a server:\n  - Run the `yarn` command in the `frontend` folder to install all dependencies.\n  - Create a `.env` file in the `frontend` according to the section on [frontend configuration](#frontend).\n  - For development purposes, you can run `yarn dev` to run the application with hot reload. For a production deployment, follow the SvelteKit instructions [here](https://svelte.dev/docs/kit/building-your-app).\n\n## Configuration\n\n### Frontend\n\nThe frontend requires only a single configuration file `.env` to be created in the `frontend/` folder with the following contents:\n\n```bash\n# NOTE: Replace http://localhost:8000 with the correct URL that your backend is hosted at!\nPUBLIC_BACKEND_URL=http://localhost:8000\n```\n\n### Backend\n\nThe backend requires the `config.json` file to be created in the `backend/` folder with the following options (all except `databaseUrl` are optional):\n\n```json\n{\n  \"port\": 8000,\n  \"basePath\": \"/\",\n  \"secureCookies\": false,\n  \"database\": \"optional: postgres (default, recommended) or mariadb\",\n  \"databaseUrl\": \"see https://pkg.go.dev/github.com/lib/pq#hdr-Connection_String_Parameters (postgres) or https://github.com/go-sql-driver/mysql?tab=readme-ov-file#dsn-data-source-name (mariadb)\"\n}\n```\n\nThe `databaseUrl` must be provided, and in production, it is recommended to make use of `secureCookies` as well. You may change the `port` as needed, and `basePath` should be modified if you are reverse proxying the backend through Apache/nginx/etc and placing the backend under another path.\n\n⚠️ *Note:* MariaDB support *will not work* with Oracle MySQL or Percona.\n\n## Security Practices and Reverse Proxying\n\nIf self-hosting, you should take a look at [Octyne's corresponding documentation](https://github.com/retrixe/octyne#security-practices-and-reverse-proxying), which is largely applicable to Concinnity's frontend and backend.\n\nFor further guidance, create an issue to expand this documentation.\n\n## API Documentation\n\nThe concinnity API is currently unstable and largely undocumented. You can find limited technical information in the backend's source code (with the frontend serving as an example of a fully functional client).\n\n## License\n\nCopyright (C) 2025 retrixe\n\nConcinnity is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nConcinnity is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with Concinnity.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretrixe%2Fconcinnity-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fretrixe%2Fconcinnity-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretrixe%2Fconcinnity-deploy/lists"}