{"id":21369516,"url":"https://github.com/jakobmoellerdev/octi-sync-server","last_synced_at":"2025-12-15T11:28:24.911Z","repository":{"id":59662676,"uuid":"538214130","full_name":"jakobmoellerdev/octi-sync-server","owner":"jakobmoellerdev","description":"An easy synchronization server","archived":false,"fork":false,"pushed_at":"2024-08-02T19:05:13.000Z","size":413,"stargazers_count":31,"open_issues_count":0,"forks_count":6,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-08-03T20:47:54.412Z","etag":null,"topics":["golang","server"],"latest_commit_sha":null,"homepage":"","language":"Go","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/jakobmoellerdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-18T19:11:05.000Z","updated_at":"2024-08-02T19:01:39.000Z","dependencies_parsed_at":"2024-02-17T02:33:44.982Z","dependency_job_id":"c3846d78-0a8c-499f-ac23-f8976d416e72","html_url":"https://github.com/jakobmoellerdev/octi-sync-server","commit_stats":{"total_commits":146,"total_committers":7,"mean_commits":"20.857142857142858","dds":"0.36986301369863017","last_synced_commit":"3425bd2e960d198a59f92846a3c433e6b8115de2"},"previous_names":["jakobmoellerdev/octi-sync-server"],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakobmoellerdev%2Focti-sync-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakobmoellerdev%2Focti-sync-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakobmoellerdev%2Focti-sync-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakobmoellerdev%2Focti-sync-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jakobmoellerdev","download_url":"https://codeload.github.com/jakobmoellerdev/octi-sync-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225861846,"owners_count":17535984,"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":["golang","server"],"created_at":"2024-11-22T07:33:00.542Z","updated_at":"2025-12-15T11:28:19.855Z","avatar_url":"https://github.com/jakobmoellerdev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Octi Sync Server - Easy Synchronization!\n\n[![Coverage Status](https://coveralls.io/repos/github/jakobmoellerdev/octi-sync-server/badge.svg?branch=main)](https://coveralls.io/github/jakobmoellerdev/octi-sync-server?branch=main)\n[![Go Report Card](https://goreportcard.com/badge/github.com/jakobmoellerdev/octi-sync-server)](https://goreportcard.com/report/github.com/jakobmoellerdev/octi-sync-server)\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fjakobmoellerdev%2Focti-sync-server.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fjakobmoellerdev%2Focti-sync-server?ref=badge_shield)\n\n[![Build](https://github.com/jakobmoellerdev/octi-sync-server/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/jakobmoellerdev/octi-sync-server/actions/workflows/build.yaml)\n[![CodeQL](https://github.com/jakobmoellerdev/octi-sync-server/actions/workflows/codeql.yml/badge.svg)](https://github.com/jakobmoellerdev/octi-sync-server/actions/workflows/codeql.yml)\n\n\n## License\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fjakobmoellerdev%2Focti-sync-server.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fjakobmoellerdev%2Focti-sync-server?ref=badge_large)\n\n\n## Developing and Operating the Server\n\n### Running the Server\n\n#### In Kubernetes\n\nPre-Requisites:\n- Kustomize\n- A Kubernetes Cluster\n\nPlease see `deploy/kustomize` for a `kustomization.yaml` that you can use to deploy the Application.\n\nBy default, the Deployment creates a Redis to join the Server which is not bound to any PV.\nThis makes it *not ready for productive use* out of the box\n\n#### From Docker\n\nPre-Requisites:\n- Docker\n\n```shell\ndocker run ghcr.io/jakobmoellerdev/octi-sync-server:latest\n```\n\nYou can verify build the build integrity with the provided `cosign.pub` Public Key:\n\n```shell\ndocker run -it --rm -v $PWD:/repo gcr.io/projectsigstore/cosign verify --key /repo/cosign.pub ghcr.io/jakobmoellerdev/octi-sync-server:latest\n```\n\nMake sure to open Port `8080` if you want the server to be reachable.\nAlso, you might want to bind in `config.yml` via volume to override configuration values.\n\n#### From Source\n\n```shell\ngo run .\n```\n\nAdjust configuration parameters in `config.yml` where necessary!\n\nFor running a redis locally for testing, use\n\n```shell\ndocker run -it --rm -p 6379:6379 --name octi-redis redis:latest\n```\n\n#### From Release\n\nFirst download the artifact:\n```shell\nVERSION=0.2.3-alpha4 \\\nRELEASE=https://github.com/jakobmoellerdev/octi-sync-server/releases/download/v$VERSION; \\\nwget $RELEASE/octi-sync-server_${VERSION}_Linux_x86_64.tar.gz\n```\n\nNext download the signature:\n\nTo verify the integrity of the checksums of the remote build before downloading:\n```shell\n## note that PUBLIC_KEY is coming from the repository here, you can also download it before and use a local mount\nPUBLIC_KEY=/repo/cosign.pub \\\nVERSION=0.2.3-alpha4 \\\nRELEASE=https://github.com/jakobmoellerdev/octi-sync-server/releases/download/v$VERSION; \\\ndocker run -it --rm -v $PWD:/repo gcr.io/projectsigstore/cosign \\\n  verify-blob --key PUBLIC_KEY \\\n  --signature $RELEASE/checksums.txt.sig \\\n  $RELEASE/checksums.txt\n```\n\nNow verify the downloaded artifact from above\n\n```shell\nPUBLIC_KEY=/repo/cosign.pub \\\nVERSION=0.2.3-alpha4 \\\nRELEASE=https://github.com/jakobmoellerdev/octi-sync-server/releases/download/v$VERSION; \\\necho \"$(wget -qO /dev/stdout $RELEASE/checksums.txt | grep octi-sync-server_${VERSION}_Linux_x86_64.tar.gz)\" | \\\nsha256sum --check\n```\n\n### Inspecting and Recreating The OpenAPI Definitions and Mocks\n\n#### V1\n\nYou can access the active JSON-Formatted OpenAPI Definition under\n\n`http://localhost:8080/v1/openapi`.\n\nYou can introspect the API with `Swagger-UI` using a static Path or from the hosted Server. \nFor ease of development, you can introspect locally with \n\n```shell\n# URL is where the server is hosted, \n# remember that by default it will be blocked by CORS!\ndocker run -it --rm \\\n    -p 80:8080 \\\n    -e URL=http://localhost:8080/v1/openapi \\\n    -v $(pwd)/api/v1:/v1 swaggerapi/swagger-ui\n```\nand then opening your browser on [http://localhost:80](http://localhost:80) while running the server.\n\nYou can recreate the Definitions and Mocks with\n\n```shell\ngo install go.uber.org/mock/mockgen@v1.6.0\ngo generate ./...\n```\n\n### Running Tests\n\n```shell\ngo test ./...\n```\n\n### Linting\n\n```shell\ndocker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.49.0 golangci-lint run\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakobmoellerdev%2Focti-sync-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjakobmoellerdev%2Focti-sync-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakobmoellerdev%2Focti-sync-server/lists"}