{"id":19299943,"url":"https://github.com/cloudogu/smeagol","last_synced_at":"2026-01-29T18:05:41.196Z","repository":{"id":12729223,"uuid":"67682399","full_name":"cloudogu/smeagol","owner":"cloudogu","description":"Store your technical documentation with in your git repository","archived":false,"fork":false,"pushed_at":"2025-04-28T14:48:32.000Z","size":10557,"stargazers_count":21,"open_issues_count":38,"forks_count":4,"subscribers_count":10,"default_branch":"develop","last_synced_at":"2025-04-28T15:25:04.364Z","etag":null,"topics":["plantuml","wiki"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"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/cloudogu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-09-08T08:07:23.000Z","updated_at":"2025-04-28T14:48:35.000Z","dependencies_parsed_at":"2024-08-05T12:15:35.753Z","dependency_job_id":"b3c0144f-97de-48a0-b80c-6e74223c907c","html_url":"https://github.com/cloudogu/smeagol","commit_stats":null,"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"purl":"pkg:github/cloudogu/smeagol","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudogu%2Fsmeagol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudogu%2Fsmeagol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudogu%2Fsmeagol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudogu%2Fsmeagol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudogu","download_url":"https://codeload.github.com/cloudogu/smeagol/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudogu%2Fsmeagol/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28882019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T16:41:59.663Z","status":"ssl_error","status_checked_at":"2026-01-29T16:39:39.641Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["plantuml","wiki"],"created_at":"2024-11-09T23:13:14.166Z","updated_at":"2026-01-29T18:05:41.149Z","avatar_url":"https://github.com/cloudogu.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![GitHub license](https://img.shields.io/github/license/cloudogu/smeagol.svg)](https://github.com/cloudogu/smeagol/blob/master/LICENSE)\n[![GitHub release](https://img.shields.io/github/release/cloudogu/smeagol.svg)](https://github.com/cloudogu/smeagol/releases)\n\n# Smeagol Dogu\n[https://cloudogu.com](https://cloudogu.com/?mtm_campaign=smeagol\u0026mtm_kwd=website\u0026mtm_source=github\u0026mtm_medium=link)\n\nThis repository contains smeagol, an wiki server which stores its files in a git repository.\n\n## Development\n\n### Environment\n\u003e **Note**: If you intend to use your local ecosystem, which will also reside on `192.168.56.2` by default, you have to set an etcd key first.\n\u003e This can be done in vagrant with the command `etcdctl set /config/_global/stage \"development\"` and restarting CAS in vagrant via `docker restart cas`.\n\n#### Setting up a development ecosystem via groovy\nSmeagol requires a proper configured Cloudogu EcoSystem in order to work properly.\nThis can be achieved by using the provided groovy execution:\n\n```bash \n./mvnw groovy:execute@up\n```\n\nThis command will clone the ecosystem repository into the `.workspace` folder, creates a `setup.json` with a proper\nconfiguration and starts the vm. After the vm has started, open the setup in your browser at\n`http://192.168.56.2:8080`, register the instance and finish the setup.\n\nThen you can access SCM-Manager at: `https://192.168.56.2/scm/`.\n\nUsername: `admin`, Password: `adminpw`\n\nWith those credentials you can also enter the VM via SSH:\n\n* `ssh admin@192.168.56.2`\n* or `cd .workspace/ecosystem; vagrant ssh`\n\nHint: Make sure your SCM-Manager has the Smeagol Plugin installed!\n\nTo stop the vm use the down execution:\n\n```bash\n./mvnw groovy:execute@down\n```\n\nIf the vm is not longer required, it can be removed with the destroy execution:\n\n```bash\n./mvnw groovy:execute@destroy\n```\n\n### REST API\n\nThe server for the REST API can be started with the run goal of the spring-boot maven plugin:\n```bash\n./mvnw clean spring-boot:run\n```\nTo access the development instance open `http://192.168.56.1:8080` in your browser.\nFor example, you can get all repositories from `http://192.168.56.1:8080/smeagol/api/v1/repositories`.\n\n### UI\n\nMake sure your SCM-Manager has the Smeagol Plugin installed!\n- https://192.168.56.2/scm/admin/plugins/available/\n\nIf Smeagol runs on your local host and you use CAS and SCM-Manger inside a CES instance please make sure the SCM-Manager CAS setting accepts any proxy like so:\n- Administration -\u003e Settings -\u003e CAS -\u003e Accept any proxy (enabled)\n\nTo start the UI development server, you should use yarn. First install the required dependencies:\n\n```bash\nyarn install\n```\n\nAfter the dependency installation has finished, start the development server:\n\n```bash\nyarn run start\n```\n\nAfter the RESTApi and the UI are successfully started, we can open Smeagol in our browser at `http://192.168.56.1:8080`.\nThe spring-boot server from the RESTApi will proxy every ui request to the UI server.\n\n### Hot Reload\n\nHot reload should work out of the box for the ui.\n\nTo enable hot reload for java classes, the application must be started with the maven goal \"spring-boot:run\". For\nIntellij we have to recompile the project or enable \"Make project automatically\", but this requires some sort of hack.\nPlease have a look at the description of the issue [IDEA-141638](https://youtrack.jetbrains.com/issue/IDEA-141638).\n\n---\n## What is the Cloudogu EcoSystem?\nThe Cloudogu EcoSystem is an open platform, which lets you choose how and where your team creates great software. Each service or tool is delivered as a Dogu, a Docker container. Each Dogu can easily be integrated in your environment just by pulling it from our registry.\n\nWe have a growing number of ready-to-use Dogus, e.g. SCM-Manager, Jenkins, Nexus Repository, SonarQube, Redmine and many more. Every Dogu can be tailored to your specific needs. Take advantage of a central authentication service, a dynamic navigation, that lets you easily switch between the web UIs and a smart configuration magic, which automatically detects and responds to dependencies between Dogus.\n\nThe Cloudogu EcoSystem is open source and it runs either on-premises or in the cloud. The Cloudogu EcoSystem is developed by Cloudogu GmbH under [AGPL-3.0-only](https://spdx.org/licenses/AGPL-3.0-only.html).\n\n## License\nCopyright © 2020 - present Cloudogu GmbH\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\nYou should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.\nSee [LICENSE](LICENSE) for details.\n\n\n---\nMADE WITH :heart:\u0026nbsp;FOR DEV ADDICTS. [Legal notice / Imprint](https://cloudogu.com/en/imprint/?mtm_campaign=ecosystem\u0026mtm_kwd=imprint\u0026mtm_source=github\u0026mtm_medium=link)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudogu%2Fsmeagol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudogu%2Fsmeagol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudogu%2Fsmeagol/lists"}