# \#documentation

**URL:** https://community.openhab.org/tag/documentation/531.md

[Latest](https://community.openhab.org/latest.md) · [Categories](https://community.openhab.org/categories.md) · [Tags](https://community.openhab.org/tags.md)

---

## [HowTo: Documentation of your (openHAB based) home automation?](https://community.openhab.org/t/howto-documentation-of-your-openhab-based-home-automation/164011)

<div class="topic-metadata">

**Author:** [@binderth](https://community.openhab.org/u/binderth)\
**Replies:** 4\
**Last updated:** [May 10, 2025, 11:34am UTC](https://community.openhab.org/t/howto-documentation-of-your-openhab-based-home-automation/164011 "2025-05-10T11:34:37Z")

</div>

My goal is to have some sort of documentation for my openHAB based home automation. Some kind of at least an overview on how the home automation is built. So, I’m sure everyone has like a bunch of different tech cramme…

---

## [Building Pages in OH 3 - Item Customization on Auto Generated Pages](https://community.openhab.org/t/building-pages-in-oh-3-item-customization-on-auto-generated-pages/115716)

<div class="topic-metadata">

**Author:** [@rlkoshak](https://community.openhab.org/u/rlkoshak)\
**Replies:** 17\
**Last updated:** [September 20, 2023, 2:36am UTC](https://community.openhab.org/t/building-pages-in-oh-3-item-customization-on-auto-generated-pages/115716 "2023-09-20T02:36:48Z")

</div>

I’m taking a cut at expanding the Getting Started tutorial for Pages. I’m going to insert them here for public comment before submitting them as a PR. I don’t think the existing three pages are sufficient for getting sta…

---

## [How to notify user about deprecations properly?](https://community.openhab.org/t/how-to-notify-user-about-deprecations-properly/145533)

<div class="topic-metadata">

**Author:** [@damihe](https://community.openhab.org/u/damihe)\
**Replies:** 5\
**Last updated:** [March 25, 2023, 7:53pm UTC](https://community.openhab.org/t/how-to-notify-user-about-deprecations-properly/145533 "2023-03-25T19:53:43Z")

</div>

Is there a standard way to notify an openHAB admin about using a deprecated feature or configuration? Use case: I am preparing a new thing type which is more powerful and takes over the logic of a bridge it’ll be attach…

---

## [How to fill the knowledge gaps that arise when reading the documentation?](https://community.openhab.org/t/how-to-fill-the-knowledge-gaps-that-arise-when-reading-the-documentation/141831)

<div class="topic-metadata">

**Author:** [@halla](https://community.openhab.org/u/halla)\
**Replies:** 10\
**Last updated:** [December 8, 2022, 7:25pm UTC](https://community.openhab.org/t/how-to-fill-the-knowledge-gaps-that-arise-when-reading-the-documentation/141831 "2022-12-08T19:25:03Z")

</div>

Platform Hardware: Raspberry Pi 3 Model B Plus Rev 1.3 Operating System: openhabian 5.10.103-v7+ OpenHAB Version: openHAB 3.3.0 - Release Build Originating Issue: openhab documentation Issue Expected Behavior: If to…

---

## [Documentation in openhab vs. current Google Assistant features](https://community.openhab.org/t/documentation-in-openhab-vs-current-google-assistant-features/140735)

<div class="topic-metadata">

**Author:** [@KaNe](https://community.openhab.org/u/KaNe)\
**Replies:** 20\
**Last updated:** [December 2, 2022, 3:35pm UTC](https://community.openhab.org/t/documentation-in-openhab-vs-current-google-assistant-features/140735 "2022-12-02T15:35:31Z")

</div>

Hi Folks, i’ve been struggled with changes in Google assistant (topic: specialcolorlight) - i solved it by searching here and putting the puzzle together. My concern is, that the documentation about google assistant an…

---

## [Openhab metrics 3.1](https://community.openhab.org/t/openhab-metrics-3-1/124151)

<div class="topic-metadata">

**Author:** [@Scriptwriter](https://community.openhab.org/u/Scriptwriter)\
**Replies:** 14\
**Last updated:** [October 10, 2022, 2:14pm UTC](https://community.openhab.org/t/openhab-metrics-3-1/124151 "2022-10-10T14:14:15Z")

</div>

i tried to integrate openhab metrics. so first - it works. for me it was difficult to find out that i have to go to “misc” to install metrics. maybe its better to add in documentation. But in documentation i found beau…

---

## [Mismatch between documentation page and github file](https://community.openhab.org/t/mismatch-between-documentation-page-and-github-file/137540)

<div class="topic-metadata">

**Author:** [@happenpappen](https://community.openhab.org/u/happenpappen)\
**Replies:** 4\
**Last updated:** [July 24, 2022, 8:36pm UTC](https://community.openhab.org/t/mismatch-between-documentation-page-and-github-file/137540 "2022-07-24T20:36:25Z")

</div>

On this page: there is a typo in the keyfile name which is at one place “openhab.pgp” (where the file is downloaded and moved to /usr/share/keyring) and in the other “openhab.gpg” (where it is referenced in the openha…

---

## [Typo in the Debian part of installation documentation](https://community.openhab.org/t/typo-in-the-debian-part-of-installation-documentation/137379)

<div class="topic-metadata">

**Author:** [@Superkikim](https://community.openhab.org/u/Superkikim)\
**Replies:** 6\
**Last updated:** [July 19, 2022, 6:33pm UTC](https://community.openhab.org/t/typo-in-the-debian-part-of-installation-documentation/137379 "2022-07-19T18:33:33Z")

</div>

Hi, There is a typo in documentation at openHAB on Linux | openHAB In the Apt Based Systems paragraph, the gpg extension is written pgp. The script line shows: curl -fsSL "https://openhab.jfrog.io/artifactory/api/gpg/…

---

## [Author of the images in the documentation](https://community.openhab.org/t/author-of-the-images-in-the-documentation/136070)

<div class="topic-metadata">

**Author:** [@ngennart](https://community.openhab.org/u/ngennart)\
**Replies:** 4\
**Last updated:** [May 29, 2022, 3:41pm UTC](https://community.openhab.org/t/author-of-the-images-in-the-documentation/136070 "2022-05-29T15:41:14Z")

</div>

Hi everyone, I am currently doing a master thesis where the topic is; role-based access control for OpenHAB users. Once the master thesis is finished, I plan to create a post that contains what exactly I did, put my the…

---

## [Windows Upgrade Instructions - Need to be Revised](https://community.openhab.org/t/windows-upgrade-instructions-need-to-be-revised/35782)

<div class="topic-metadata">

**Author:** [@KidSquid](https://community.openhab.org/u/KidSquid)\
**Replies:** 13\
**Last updated:** [November 4, 2021, 6:36am UTC](https://community.openhab.org/t/windows-upgrade-instructions-need-to-be-revised/35782 "2021-11-04T06:36:13Z")

</div>

The current upgrade instructions for Windows users instruct you to delete an assortment of files, then copy over the new version on top of your current installation. http://docs.openhab.org/installation/windows.html#sta…

---

## [Getting Started with OH3: rewriting the tutorial - 6. Model your home with Items & link Channels](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-6-model-your-home-with-items-link-channels/101008)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 91\
**Last updated:** [September 27, 2021, 9:55pm UTC](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-6-model-your-home-with-items-link-channels/101008 "2021-09-27T21:55:00Z")

</div>

This Wiki topic’s goal is to serve as a working document, in order to provide an up-to-date tutorial for OH3 aimed at new users and novices. Everyone is welcome and encouraged to edit it, when we’re satisfied it will ma…

---

## [HOMEGAR - Version requirement is a nightly build - is that really true?](https://community.openhab.org/t/homegar-version-requirement-is-a-nightly-build-is-that-really-true/126456)

<div class="topic-metadata">

**Author:** [@dolittle](https://community.openhab.org/u/dolittle)\
**Replies:** 3\
**Last updated:** [September 14, 2021, 5:00am UTC](https://community.openhab.org/t/homegar-version-requirement-is-a-nightly-build-is-that-really-true/126456 "2021-09-14T05:00:34Z")

</div>

Hi, as I was playing around with my homematic installation I noticed that in the documentation the required minimum version for Homegear is stated as 0.8.0 - 1988. Unfortunately the 0.8.x version is used for the nightly…

---

## [Building Pages in OH 3 - Custom User Defined Widgets](https://community.openhab.org/t/building-pages-in-oh-3-custom-user-defined-widgets/115720)

<div class="topic-metadata">

**Author:** [@rlkoshak](https://community.openhab.org/u/rlkoshak)\
**Replies:** 28\
**Last updated:** [June 7, 2021, 2:54pm UTC](https://community.openhab.org/t/building-pages-in-oh-3-custom-user-defined-widgets/115720 "2021-06-07T14:54:13Z")

</div>

I’m taking a cut at expanding the Getting Started tutorial for Pages. I’m going to insert them here for public comment before submitting them as a PR. I don’t think the existing three pages are sufficient for getting sta…

---

## [openHAB JavaDoc down](https://community.openhab.org/t/openhab-javadoc-down/122223)

<div class="topic-metadata">

**Author:** [@secureHAB](https://community.openhab.org/u/secureHAB)\
**Replies:** 10\
**Last updated:** [May 17, 2021, 2:43pm UTC](https://community.openhab.org/t/openhab-javadoc-down/122223 "2021-05-17T14:43:51Z")

</div>

Dear community, currently the JacaDoc’s of openHAB are down via https://next.openhab.org/javadoc/latest/ ==\> Status Code 404 Or is my link outdated?

---

## [Controlling openHAB with a Mac](https://community.openhab.org/t/controlling-openhab-with-a-mac/121495)

<div class="topic-metadata">

**Author:** [@bobfa](https://community.openhab.org/u/bobfa)\
**Replies:** 3\
**Last updated:** [April 28, 2021, 3:32pm UTC](https://community.openhab.org/t/controlling-openhab-with-a-mac/121495 "2021-04-28T15:32:23Z")

</div>

I just installed openHAB on a Raspberry Pi4. All is well. Notes on documentation when using Safari on a Mac. You need to use http://openhabian.local:8080 The documentation does not mention the .local that I saw.

---

## [3.0.2 Documentation Links Broken](https://community.openhab.org/t/3-0-2-documentation-links-broken/121259)

<div class="topic-metadata">

**Author:** [@delid4ve](https://community.openhab.org/u/delid4ve)\
**Replies:** 3\
**Last updated:** [April 23, 2021, 3:22pm UTC](https://community.openhab.org/t/3-0-2-documentation-links-broken/121259 "2021-04-23T15:22:11Z")

</div>

So went to get the latest source to compile 3.0.2 for my QNAP NAS and the links in the docs are all broken. Found the download through the post. Thanks

---

## [OH3 Rules — DSL vs Next-Gen](https://community.openhab.org/t/oh3-rules-dsl-vs-next-gen/117678)

<div class="topic-metadata">

**Author:** [@jamgood96](https://community.openhab.org/u/jamgood96)\
**Replies:** 10\
**Last updated:** [February 27, 2021, 8:43pm UTC](https://community.openhab.org/t/oh3-rules-dsl-vs-next-gen/117678 "2021-02-27T20:43:21Z")

</div>

I’ve recently upgraded to openHAB 3 and am finding it a bit confusing what the state of the rules are. The official docs (Textual Rules | openHAB) mention nothing of the next-gen rules. The only way I knew about them was…

---

## [Getting Started with OH3: rewriting the tutorial - 5. Adding a Thing (advanced)](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-5-adding-a-thing-advanced/100997)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 8\
**Last updated:** [February 27, 2021, 9:29am UTC](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-5-adding-a-thing-advanced/100997 "2021-02-27T09:29:56Z")

</div>

This Wiki topic’s goal is to serve as a working document, in order to provide an up-to-date tutorial for OH3 aimed at new users and novices. Everyone is welcome and encouraged to edit it, when we’re satisfied it will ma…

---

## [Draft update IFTTT docs](https://community.openhab.org/t/draft-update-ifttt-docs/63301)

<div class="topic-metadata">

**Author:** [@Maurits28](https://community.openhab.org/u/Maurits28)\
**Replies:** 10\
**Last updated:** [February 25, 2021, 10:58am UTC](https://community.openhab.org/t/draft-update-ifttt-docs/63301 "2021-02-25T10:58:52Z")

</div>

I noticed that the IFTTT page was a mere copy of some promotional page that was used in the past. Below you can find a first updated draft. Some remarks: Removed information on DO button, as this was integrated into …

---

## [Documentation on Item creation in OH3](https://community.openhab.org/t/documentation-on-item-creation-in-oh3/116987)

<div class="topic-metadata">

**Author:** [@Henrik\_Wahlberg](https://community.openhab.org/u/Henrik_Wahlberg)\
**Replies:** 9\
**Last updated:** [February 16, 2021, 9:04pm UTC](https://community.openhab.org/t/documentation-on-item-creation-in-oh3/116987 "2021-02-16T21:04:49Z")

</div>

Hi. Without knowing this: /-\> User Interfaces hardware -\> binding -\> Things -\> Channels -\> Items |-\> Rules \\-\> …

---

## [New User Interfaces Section on the official docs](https://community.openhab.org/t/new-user-interfaces-section-on-the-official-docs/116432)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 1\
**Last updated:** [February 8, 2021, 7:31pm UTC](https://community.openhab.org/t/new-user-interfaces-section-on-the-official-docs/116432 "2021-02-08T19:31:23Z")

</div>

Hi all, I have at last added a whole new section in the documentation for everything related to UIs: mostly the main UI, but also others (i.e. sitemaps, HABPanel and the mobile apps have been migrated there). So you’ll…

---

## [Getting Started with OH3: rewriting the tutorial - 1. Introduction](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-1-introduction/100982)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 112\
**Last updated:** [December 21, 2020, 8:39pm UTC](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-1-introduction/100982 "2020-12-21T20:39:48Z")

</div>

This Wiki topic’s goal is to serve as a working document, in order to provide an up-to-date tutorial for OH3 aimed at new users and novices. Everyone is welcome and encouraged to edit it, when we’re satisfied it will ma…

---

## [What's the deal with Python rules in OpenHab 3?](https://community.openhab.org/t/whats-the-deal-with-python-rules-in-openhab-3/115021)

<div class="topic-metadata">

**Author:** [@NetDirection](https://community.openhab.org/u/NetDirection)\
**Replies:** 29\
**Last updated:** [February 1, 2021, 5:33pm UTC](https://community.openhab.org/t/whats-the-deal-with-python-rules-in-openhab-3/115021 "2021-02-01T17:33:15Z")

</div>

I’m running OH3 and have installed the Python rules engine, so I can write rules in Python straight into the OH3 frontend. What I imagined I was getting was a working method for writing rules in Python and a learning cu…

---

## [Building Pages in the OH 3 UI - Introduction](https://community.openhab.org/t/building-pages-in-the-oh-3-ui-introduction/115689)

<div class="topic-metadata">

**Author:** [@rlkoshak](https://community.openhab.org/u/rlkoshak)\
**Replies:** 1\
**Last updated:** [January 31, 2021, 8:30pm UTC](https://community.openhab.org/t/building-pages-in-the-oh-3-ui-introduction/115689 "2021-01-31T20:30:13Z")

</div>

I’m taking a cut at expanding the Getting Started tutorial for Pages. I’m going to insert them here for public comment before submitting them as a PR. I don’t think the existing three pages are sufficient for getting sta…

---

## [\[wiki\] Getting Started with OH3: rewriting the tutorial - 9. Make everything work together: rules (advanced)](https://community.openhab.org/t/wiki-getting-started-with-oh3-rewriting-the-tutorial-9-make-everything-work-together-rules-advanced/101046)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 23\
**Last updated:** [January 9, 2021, 7:02pm UTC](https://community.openhab.org/t/wiki-getting-started-with-oh3-rewriting-the-tutorial-9-make-everything-work-together-rules-advanced/101046 "2021-01-09T19:02:53Z")

</div>

This has now been merged into the main docs (should be available sometime in the next day or so after the next build). Thanks for all comments and edits! I’m closing this thread now. rlkoshak This Wiki topic’s goal is…

---

## [\[Wiki\] How to contribute to the openHAB Documentation](https://community.openhab.org/t/wiki-how-to-contribute-to-the-openhab-documentation/111308)

<div class="topic-metadata">

**Author:** [@Confectrician](https://community.openhab.org/u/Confectrician)\
**Replies:** 6\
**Last updated:** [December 25, 2020, 10:05pm UTC](https://community.openhab.org/t/wiki-how-to-contribute-to-the-openhab-documentation/111308 "2020-12-25T22:05:14Z")

</div>

Contributing to the Documentation can be tricky, especially when you don’t have a software/programming background. One reason for this may be way of how we are storing and processing the documentation pages. We do it w…

---

## [Getting Started with OH3: rewriting the tutorial - 4. Adding a Thing (intermediate)](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-4-adding-a-thing-intermediate/100995)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 3\
**Last updated:** [December 8, 2020, 3:03pm UTC](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-4-adding-a-thing-intermediate/100995 "2020-12-08T15:03:48Z")

</div>

This Wiki topic’s goal is to serve as a working document, in order to provide an up-to-date tutorial for OH3 aimed at new users and novices. Everyone is welcome and encouraged to edit it, when we’re satisfied it will ma…

---

## [Getting Started with OH3: rewriting the tutorial - 3. Adding a Thing (simple)](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-3-adding-a-thing-simple/100992)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 3\
**Last updated:** [December 2, 2020, 6:04pm UTC](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-3-adding-a-thing-simple/100992 "2020-12-02T18:04:46Z")

</div>

This Wiki topic’s goal is to serve as a working document, in order to provide an up-to-date tutorial for OH3 aimed at new users and novices. Everyone is welcome and encouraged to edit it, when we’re satisfied it will ma…

---

## [Getting Started with OH3: rewriting the tutorial - 2. First steps](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-2-first-steps/100990)

<div class="topic-metadata">

**Author:** [@ysc](https://community.openhab.org/u/ysc)\
**Replies:** 3\
**Last updated:** [December 2, 2020, 5:44pm UTC](https://community.openhab.org/t/getting-started-with-oh3-rewriting-the-tutorial-2-first-steps/100990 "2020-12-02T17:44:08Z")

</div>

This Wiki topic’s goal is to serve as a working document, in order to provide an up-to-date tutorial for OH3 aimed at new users and novices. Everyone is welcome and encouraged to edit it, when we’re satisfied it will ma…

---

## [Link Channel in PaperUI Documentation](https://community.openhab.org/t/link-channel-in-paperui-documentation/99719)

<div class="topic-metadata">

**Author:** [@hashlog](https://community.openhab.org/u/hashlog)\
**Replies:** 1\
**Last updated:** [May 28, 2020, 8:50pm UTC](https://community.openhab.org/t/link-channel-in-paperui-documentation/99719 "2020-05-28T20:50:20Z")

</div>

When linking a channel in PaperUI a popup appears and a profile and an item have to be selected. Can somebody point me to the documentation of the different profiles? If there is none, can somebody explain to me the dif…

[Next page](https://community.openhab.org/tag/documentation/531.md?match_all_tags=true&page=1&tags%5B%5D=documentation)
