Adding README steps to develop on OMERO using docker-compose by Rdornier · Pull Request #21 · ome/docker-example-omero

Rdornier · 2025-12-04T17:21:58Z

I'm adding here a bit of documentation regarding OMERO development using docker-compose.
Hope it will help,

Rémy.

jburel · 2025-12-05T08:22:48Z

@@ -0,0 +1,151 @@
+# Developping on OMERO - Creating your own dev server with docker-compose


Suggested change

# Developping on OMERO - Creating your own dev server with docker-compose

# Developping on OMERO - Creating your own development server with docker-compose

jburel · 2025-12-05T08:23:11Z

@@ -0,0 +1,151 @@
+# Developping on OMERO - Creating your own dev server with docker-compose
+This section targets any developments you want to do on any OMERO web application or any OMERO plugins (omero-iviewer, omero-figure, tagsearch...)


Suggested change

This section targets any developments you want to do on any OMERO web application or any OMERO plugins (omero-iviewer, omero-figure, tagsearch...)

This section targets any development you want to do on any OMERO web application or any OMERO plugins (omero-iviewer, omero-figure, tagsearch, etc.).

jburel · 2025-12-05T08:23:28Z

+## Docker installation
+You need to download and install [Docker desktop](https://www.docker.com/products/docker-desktop/) 
+
+> For Windows user, make sur that you also have [Windows subsystem Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) installed on your machine.


Suggested change

> For Windows user, make sur that you also have [Windows subsystem Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) installed on your machine.

> For Windows user, make sure that you also have [Windows subsystem Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) installed on your machine.

jburel · 2025-12-05T08:24:41Z

+
+
+3. Open a terminal in the repository of the ``docker-compose.yaml``
+4. Write down <kbd>docker compose pull</kbd> to get the docker images (they are are downloaded from docker hub)


Suggested change

4. Write down <kbd>docker compose pull</kbd> to get the docker images (they are are downloaded from docker hub)

4. Write down <kbd>docker compose pull</kbd> to get the Docker images (they are downloaded from Docker Hub).

jburel · 2025-12-05T08:24:52Z

+> You always need to have Docker desktop open and ready to make anything with docker.
+
+
+3. Open a terminal in the repository of the ``docker-compose.yaml``


Suggested change

3. Open a terminal in the repository of the ``docker-compose.yaml``

3. Open a terminal in the repository of the ``docker-compose.yaml``.

jburel · 2025-12-05T08:53:15Z

+5. Follow **Step 1 steps (from 3 to 8)** to re-build and re-launch your containers. **Don't forget to shut down your containers before !**
+
+5. Modify any file under `omero-figure/src` and save them.
+6. Build the plugin files ; have a look to the github repo of the plugin to know how to build it.


Suggested change

6. Build the plugin files ; have a look to the github repo of the plugin to know how to build it.

6. Build the plugin files; have a look to the GitHub repository of the plugin to know how to build it.

jburel · 2025-12-05T08:53:43Z

+5. Modify any file under `omero-figure/src` and save them.
+6. Build the plugin files ; have a look to the github repo of the plugin to know how to build it.
+
+> **Note:** This is an important step. Only files under `plugin-name/plugin_name` will be read and executed. So, if you don't build the plugin, then you'll not see any changes even if you modified files under `plugin-name/src` and it is not always possible to modify the files directly under `plugin-name/plugin_name`


Suggested change

> **Note:** This is an important step. Only files under `plugin-name/plugin_name` will be read and executed. So, if you don't build the plugin, then you'll not see any changes even if you modified files under `plugin-name/src` and it is not always possible to modify the files directly under `plugin-name/plugin_name`

> **Note:** This is an important step. Only files under `plugin-name/plugin_name` will be read and executed. So, if you don't build the plugin, then you will not see any changes even if you modified files under `plugin-name/src` and it is not always possible to modify the files directly under `plugin-name/plugin_name`

jburel · 2025-12-05T08:54:00Z

+
+> **Note:** This is an important step. Only files under `plugin-name/plugin_name` will be read and executed. So, if you don't build the plugin, then you'll not see any changes even if you modified files under `plugin-name/src` and it is not always possible to modify the files directly under `plugin-name/plugin_name`
+
+8. On docker desktop, restart the **OMERO-WEB container ONLY**


Suggested change

8. On docker desktop, restart the **OMERO-WEB container ONLY**

8. In Docker desktop, restart the **OMERO-WEB container ONLY**

jburel · 2025-12-05T08:54:10Z

 - https://github.com/ome/omero-web-docker/blob/master/README.md
+
+
+## Devlopping OMERO


Suggested change

## Devlopping OMERO

## Developing OMERO

jburel · 2025-12-05T08:55:04Z

+
+## Devlopping OMERO
+
+To use a docker compose to develop OMERO plugins, you can follow some guidelines described in this DEV-README


Suggested change

To use a docker compose to develop OMERO plugins, you can follow some guidelines described in this DEV-README

To use ``docker compose`` to develop OMERO plugins, please follow the guidelines described in this DEV-README.

jburel

Proposed adjustments

Rdornier · 2025-12-05T11:28:39Z

Thanks @jburel for your careful review. I've update the readme accordingly

joshmoore · 2025-12-06T09:57:50Z

Only caveat that I didn't get a chance to say is that there are several other repos that use the same structure. I wouldn't want us to copy it to all, but thoughts welcome on how we might make others aware of it. Thanks again, @Rdornier !

Rdornier · 2025-12-08T07:56:38Z

Thanks for merging !
@joshmoore what are the other repos you are talking about ? Maybe we could just point the other repos to this readme

joshmoore · 2025-12-08T18:36:50Z

@Rdornier I mean e.g. the other repos listed from https://github.com/ome/omero-deployment-examples like:

Rdornier · 2025-12-10T07:35:25Z

Ok, I see. In order to make others aware of it, I would modify the README of each repo to point to the DEV-README of docker-example-omero. As it seems to be the 'basic' docker example, on which the others are built on, it's not out of the scope to point to this file. Seems ok for you ?

joshmoore · 2025-12-10T09:08:17Z

Sounds great, thanks!

pwalczysko · 2025-12-18T12:26:55Z

@Rdornier I mean e.g. the other repos listed from https://github.com/ome/omero-deployment-examples like:
* https://github.com/ome/docker-example-omero-readonly/tree/0d65ccfe445860fa217c717c2588fd53b3a5ce50

* https://github.com/ome/docker-example-omero-grid/tree/947ef6ee42268354193cbdd86e6b7cb79e809dbb

* etc.

Sorry for coming late to this. I just wanted to draw your attention @joshmoore @Rdornier to the sheer amount of the repos mentioned by @joshmoore - the maintenance there was discussed with @jburel and we agree that only one will be supported/maintained going ahead. I would suggest 1 for docker and 1 for ansible.

For docker: the docker-example-omero == the repo we are in now
For ansible: prod-playbooks == the main public ansible playbooks repo which is being actively maintained (the GHA is running and green there, and the playbook is also tested manually during OME Teams prod server deployments)

If more repos should be maintained, then the team members would have to be given the elevated rights to do so (for example, the https://github.com/ome/docker-example-omero-readonly has GHA disabled and there is no possibility for me to switch it back on).

Rdornier · 2026-01-09T07:44:47Z

@joshmoore @pwalczysko Just to clarify: according to ome/status#7, should we still update the README of all docker-example-omero... from this repo https://github.com/ome/omero-deployment-examples or is the current one enough ?

pwalczysko · 2026-01-09T10:02:18Z

should we still update the README of all docker-example-omero... from this repo https://github.com/ome/omero-deployment-examples or is the current one enough ?

@Rdornier imho, the currect one is enough. Although the update "could" be propagated to the other repos in the https://github.com/ome/omero-deployment-examples, imho the repos which are not listed in https://github.com/ome/status now in the section but are in https://github.com/ome/omero-deployment-examples should be archived. I was making my remark with the intention that you @Rdornier do not spend time on some large work until we clarify this (cc @joshmoore @jburel )

Rdornier · 2026-01-09T10:23:57Z

Ok sounds good to me, thanks @pwalczysko !
So I'll wait for a clear decision on that until doing more.

joshmoore · 2026-01-11T14:56:26Z

I defer on whether or not to archive them. If so, I'd put some short message in the readmes with "see the main one", date archived, etc.

Rdornier and others added 2 commits December 4, 2025 17:55

Adding dev readme

9e00632

Update DEV_README.md

6e9f25c

jburel reviewed Dec 5, 2025

View reviewed changes

Rdornier added 3 commits December 5, 2025 12:21

Update DEV_README.md

44f4401

Update README.md

2b52f19

Update README.md

064d878

jburel merged commit 4434ad1 into ome:master Dec 6, 2025
1 check passed

pwalczysko mentioned this pull request Dec 18, 2025

Replace "...examples" with docker-example-omero and add prod-playbooks ome/status#7

Merged

		@@ -0,0 +1,151 @@
		# Developping on OMERO - Creating your own dev server with docker-compose

		@@ -0,0 +1,151 @@
		# Developping on OMERO - Creating your own dev server with docker-compose
		This section targets any developments you want to do on any OMERO web application or any OMERO plugins (omero-iviewer, omero-figure, tagsearch...)

	This section targets any developments you want to do on any OMERO web application or any OMERO plugins (omero-iviewer, omero-figure, tagsearch...)
	This section targets any development you want to do on any OMERO web application or any OMERO plugins (omero-iviewer, omero-figure, tagsearch, etc.).

	> For Windows user, make sur that you also have [Windows subsystem Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) installed on your machine.
	> For Windows user, make sure that you also have [Windows subsystem Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) installed on your machine.



		3. Open a terminal in the repository of the ``docker-compose.yaml``
		4. Write down <kbd>docker compose pull</kbd> to get the docker images (they are are downloaded from docker hub)

		> You always need to have Docker desktop open and ready to make anything with docker.


		3. Open a terminal in the repository of the ``docker-compose.yaml``

	6. Build the plugin files ; have a look to the github repo of the plugin to know how to build it.
	6. Build the plugin files; have a look to the GitHub repository of the plugin to know how to build it.

	> Note: This is an important step. Only files under `plugin-name/plugin_name` will be read and executed. So, if you don't build the plugin, then you'll not see any changes even if you modified files under `plugin-name/src` and it is not always possible to modify the files directly under `plugin-name/plugin_name`
	> Note: This is an important step. Only files under `plugin-name/plugin_name` will be read and executed. So, if you don't build the plugin, then you will not see any changes even if you modified files under `plugin-name/src` and it is not always possible to modify the files directly under `plugin-name/plugin_name`


		> Note: This is an important step. Only files under `plugin-name/plugin_name` will be read and executed. So, if you don't build the plugin, then you'll not see any changes even if you modified files under `plugin-name/src` and it is not always possible to modify the files directly under `plugin-name/plugin_name`

		8. On docker desktop, restart the OMERO-WEB container ONLY

	8. On docker desktop, restart the OMERO-WEB container ONLY
	8. In Docker desktop, restart the OMERO-WEB container ONLY

		- https://github.com/ome/omero-web-docker/blob/master/README.md


		## Devlopping OMERO


		## Devlopping OMERO

		To use a docker compose to develop OMERO plugins, you can follow some guidelines described in this DEV-README No newline at end of file

	To use a docker compose to develop OMERO plugins, you can follow some guidelines described in this DEV-README
	To use ``docker compose`` to develop OMERO plugins, please follow the guidelines described in this DEV-README.

Conversation

Rdornier commented Dec 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jburel left a comment

Choose a reason for hiding this comment

Uh oh!

Rdornier commented Dec 5, 2025

Uh oh!

Uh oh!

joshmoore commented Dec 6, 2025

Uh oh!

Rdornier commented Dec 8, 2025

Uh oh!

joshmoore commented Dec 8, 2025

Uh oh!

Rdornier commented Dec 10, 2025

Uh oh!

joshmoore commented Dec 10, 2025

Uh oh!

pwalczysko commented Dec 18, 2025

Uh oh!

Rdornier commented Jan 9, 2026

Uh oh!

pwalczysko commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rdornier commented Jan 9, 2026

Uh oh!

joshmoore commented Jan 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pwalczysko commented Jan 9, 2026 •

edited

Loading