{"id":18336196,"url":"https://github.com/openremote/documentation","last_synced_at":"2025-06-11T16:38:10.446Z","repository":{"id":242599731,"uuid":"809846693","full_name":"openremote/documentation","owner":"openremote","description":"OpenRemote Documentation","archived":false,"fork":false,"pushed_at":"2025-06-08T12:20:33.000Z","size":19474,"stargazers_count":4,"open_issues_count":21,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-06-09T19:18:19.247Z","etag":null,"topics":["documentation","iot","iot-platform","openremote"],"latest_commit_sha":null,"homepage":"https://docs.openremote.io","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openremote.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-06-03T15:01:26.000Z","updated_at":"2025-05-22T11:39:59.000Z","dependencies_parsed_at":"2024-09-18T13:15:10.419Z","dependency_job_id":"63648f2e-e25d-4eb7-9a9b-db73248be32a","html_url":"https://github.com/openremote/documentation","commit_stats":null,"previous_names":["openremote/documentation"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openremote/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openremote%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openremote%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openremote%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openremote%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openremote","download_url":"https://codeload.github.com/openremote/documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openremote%2Fdocumentation/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259299123,"owners_count":22836477,"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":["documentation","iot","iot-platform","openremote"],"created_at":"2024-11-05T20:06:43.613Z","updated_at":"2025-06-11T16:38:10.427Z","avatar_url":"https://github.com/openremote.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenRemote Documentation\n\n[![GitHub Actions Status](https://github.com/openremote/documentation/actions/workflows/ci_cd.yml/badge.svg?branch=main)](https://github.com/openremote/documentation/actions/workflows/ci_cd.yml)\n\nThis repository contains the OpenRemote documentation hosted on https://docs.openremote.io/ as Markdown files in the [docs directory](docs).\n\nThe documentation website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.\nThe OpenAPI documentation is generated using the [Docusaurus OpenAPI Docs](https://docusaurus-openapi.tryingpan.dev/) plug-in.\n\n### Installation\n\n```shell\n$ yarn\n```\n\n### Local Development\n\n```shell\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```shell\n$ yarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\nWhen the static content has been generated it can be tested using:\n\n```shell\n$ yarn serve\n```\n\n### OpenAPI Documentation\n\nTo update the OpenAPI Documentation do the following:\n\n1. Update the `api/openapi.yaml` specification.  \n   It can be downloaded from a running OpenRemote instance, e.g.:  \n   `wget -O api/openapi.yaml http://localhost:8080/api/master/openapi.yaml`\n2. Replace the server URL in `api/openapi.yaml` from `/api/{realm}` to `https://demo.openremote.io/api/{realm}`, e.g.:  \n   `sed -i 's#/api/{realm}/#https://demo.openremote.io/api/{realm}/#g' api/openapi.yaml`\n3. Remove the previously generated OpenAPI documentation using:  \n   `yarn clean-api-docs all`\n4. Regenerate the OpenAPI documentation using:  \n   `yarn gen-api-docs all`\n\n### Deployment\n\nThe deployment is done automatically by a GitHub Actions workflow when commits are pushed to the \"main\" branch.\n\nIt can also be done manually using the \"deploy\" command.\n\nUsing SSH:\n\n```shell\n$ USE_SSH=true yarn deploy\n```\n\nNot using SSH:\n\n```shell\n$ GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n```\n\nIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenremote%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenremote%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenremote%2Fdocumentation/lists"}