{"id":22914158,"url":"https://github.com/suse/geekos-backend","last_synced_at":"2025-05-12T13:43:10.731Z","repository":{"id":38235834,"uuid":"438803860","full_name":"SUSE/geekos-backend","owner":"SUSE","description":"Backend application for geekos.io","archived":false,"fork":false,"pushed_at":"2025-03-21T18:06:30.000Z","size":597,"stargazers_count":7,"open_issues_count":22,"forks_count":3,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-26T18:54:37.255Z","etag":null,"topics":["mongodb","rails","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SUSE.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-15T23:38:46.000Z","updated_at":"2025-02-18T22:45:38.000Z","dependencies_parsed_at":"2024-06-04T12:43:57.715Z","dependency_job_id":"c4e6d7f1-0f92-4fa8-8975-b1b30f110dab","html_url":"https://github.com/SUSE/geekos-backend","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/SUSE%2Fgeekos-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fgeekos-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fgeekos-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fgeekos-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SUSE","download_url":"https://codeload.github.com/SUSE/geekos-backend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253749482,"owners_count":21958133,"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":["mongodb","rails","ruby"],"created_at":"2024-12-14T05:13:31.930Z","updated_at":"2025-05-12T13:43:10.694Z","avatar_url":"https://github.com/SUSE.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Maintainability](https://api.codeclimate.com/v1/badges/ff0dff43b4acf5d77303/maintainability)](https://codeclimate.com/github/SUSE/geekos-backend/maintainability)\n[![CodeQL](https://github.com/SUSE/geekos-backend/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/SUSE/geekos-backend/actions/workflows/codeql-analysis.yml)\n[![Brakeman Scan](https://github.com/SUSE/geekos-backend/actions/workflows/brakeman-analysis.yml/badge.svg)](https://github.com/SUSE/geekos-backend/actions/workflows/brakeman-analysis.yml)\n[![Rspec](https://github.com/SUSE/geekos-backend/actions/workflows/rubyonrails.yml/badge.svg)](https://github.com/SUSE/geekos-backend/actions/workflows/rubyonrails.yml)\n[![Coverage](https://codecov.io/gh/SUSE/geekos-backend/branch/main/graph/badge.svg?token=65YS1lM0mV)](https://codecov.io/gh/SUSE/geekos-backend)\n\n# Geekos\n\nGeekos is a server application to query and manage a community of users.\nIt can sync user attributes and hierarchy from LDAP and other backend systems.\n\nFeatures:\n\n* Fast fulltext search over defined attributes\n* Sync + combine user data from different systems into a flexible schema (MongoDB)\n* Overwriting of defined fields\n* Extensible crawlers to collect user data from different backend systems\n* REST \u0026 GraphQL JSON APIs\n* Storing user images\n* Supporting location/room/coordinates per user\n\n\n## Development Setup\n\nAs a persistent storage, the app uses [MongoDB](https://www.mongodb.com/).\nThe simplest way is to start it in a container (set a local path as 'local_volume'\nto persist the database):\n\n`docker run -d --name geekos-mongo -v \u003clocal_volume\u003e:/data/db -p 27017:27017 mongo:6.0`\n\nGeekos reads its configuration from environment variables, or from the file `config/application.yml`\nusing [figaro](https://github.com/laserlemon/figaro).\n\nPlease see `.ruby_version` for the required Ruby, install bundler with\n`gem install bundler:2.3.7` and install dependencies by calling `bundle`.\nTo start the server, run: `\u003e bundle exec rails s -b 0.0.0.0`\n\nTo export the graphql schema, run: `bundle exec rake graphql:export`\n\n## Importing data\n\n* To run the default set of crawlers, run: `Crawler.run`\n* To run only one specific crawler, run for example: `Crawler::Ldap.new.run`\n* After initial import, create indexes: `\u003e bundle exec rake db:mongoid:create_indexes`\n\n\n## Testing\n\nTo run the code linting and test suite, run: `bunde exec rubocop` and `bundle exec rspec`.\nThe repository is also covered with automatic Github Actions jobs. You can\nrun those locally with the tool [act](https://github.com/nektos/act).\nFor example `act -j test`.\n\n## Deployment\n\n### Docker\n\nThe container image gets build with: \u003cbr\u003e\n`docker build -t geekos-backend .`\n\nYou can run the image with this command: \u003cbr\u003e `docker run -p 3000:3000 -e geekos_mongodb_server=172.17.0.1 -e SECRET_KEY_BASE=5fadcd -e RAILS_LOG_TO_STDOUT=true --rm geekos-backend` \u003cbr\u003e\n(172.17.0.1 is the Docker host IP, see config/application.yml.template for all available env vars)\n\nTo open a shell inside of the container: \u003cbr\u003e `docker run --rm -ti geekos-backend /bin/bash`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuse%2Fgeekos-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuse%2Fgeekos-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuse%2Fgeekos-backend/lists"}