Skip to content

Commit a911566

Browse files
authored
Fix/update readme (#60)
* Clearly state that https is not yet supported (requires secure websocket, not a reverse proxy) * Updated screenshot * Clarify wording and remove irrelevant sections
1 parent b12d58f commit a911566

File tree

2 files changed

+10
-70
lines changed

2 files changed

+10
-70
lines changed

README.md

Lines changed: 10 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Cockpit ROS 2 Diagnostics
22

3-
This is a Cockpit module that is intended to be installed alongside [Cockpit](https://cockpit-project.org/) and connects to the [foxglove bridge](https://docs.foxglove.dev/docs/connecting-to-data/ros-foxglove-bridge)
3+
This is a Cockpit application that is intended to be installed alongside [Cockpit](https://cockpit-project.org/) and connects to the [foxglove bridge](https://docs.foxglove.dev/docs/connecting-to-data/ros-foxglove-bridge)
44

5-
This module is built on the cockpit starter kit: https://github.com/cockpit-project/starter-kit and using modified code files from https://github.com/tier4/roslibjs-foxglove.
5+
This application is built on the Cockpit starter kit (https://github.com/cockpit-project/starter-kit) and using modified code files from https://github.com/tier4/roslibjs-foxglove.
66

77
![Screenshot of Main View](screenshots/ScreenshotPluginHome.png)
88

99
# Installation instructions
1010

11-
This is installed and running automatically on Clearpath Robots without any manual installation required.
11+
This is installed and running automatically on Clearpath Robots without any manual installation required. For all other ROS computers, proceed with the following instructions.
1212

13-
The following instructions should be completed on the computer that is to be monitored and managed using the cockpit interface. In most cases this will be the robot computer.
13+
The following instructions should be completed on the computer that is to be monitored and managed using the Cockpit interface. In most cases this will be the robot computer.
1414

1515
1. Install cockpit: https://cockpit-project.org/running.html#ubuntu
1616

@@ -22,13 +22,13 @@ The following instructions should be completed on the computer that is to be mon
2222
sudo apt update
2323
```
2424

25-
3. Install this module and the foxglove bridge
25+
3. Install this module and the Foxglove bridge
2626

2727
```bash
2828
sudo apt install cockpit-ros2-diagnostics ros-$ROS_DISTRO-foxglove-bridge
2929
```
3030

31-
4. In order to open the UI on a remote computer and connect to the foxglove bridge, either this has to happen over an unsecured connection (http) or cockpit must be placed behind a reverse proxy. The currently supported option is to set cockpit up for an unsecure connection. Allow an unencrypted HTTP connection by creating the [cockpit.conf](https://cockpit-project.org/guide/latest/cockpit.conf.5) file and set `AllowUnencrypted=true` in the `WebService` section.
31+
4. In order to open the UI on a remote computer and connect to the Foxglove bridge, an unsecured connection (http) must be used. Allow an unencrypted HTTP connection by creating the [cockpit.conf](https://cockpit-project.org/guide/latest/cockpit.conf.5) file and set `AllowUnencrypted=true` in the `WebService` section. This is all done by running the following command:
3232

3333
```bash
3434
echo "[WebService]
@@ -37,15 +37,15 @@ The following instructions should be completed on the computer that is to be mon
3737

3838
# Usage Instructions
3939

40-
1. If not using with a Clearpath Robot then you will need to start your [foxglove bridge](https://docs.foxglove.dev/docs/connecting-to-data/ros-foxglove-bridge) manually. It must be launched with the default port (8765):
40+
1. If not using a Clearpath Robot then you will need to start your [Foxglove bridge](https://docs.foxglove.dev/docs/connecting-to-data/ros-foxglove-bridge) manually. It must be launched with the default port (8765):
4141

4242
```bash
4343
ros2 launch foxglove_bridge foxglove_bridge_launch.xml
4444
```
4545

46-
2. Open a supported browser and go to `http://<ip-address>:9090` but replace `<ip-address>` with the ip address or hostname of your robot computer. Remember to use the IP address for the network that over which you are connecting to the robot. In order for the websocket connection to work and successfully receive the ROS 2 topics, cockpit must be accessed over http. This is an unsecure connection but it is the simplest to configure. If a secure connection is required then cockpit must be setup behind a reverse proxy.
46+
2. Open a [supported browser](https://cockpit-project.org/running) and go to `http://<ip-address>:9090` but replace `<ip-address>` with the ip address or hostname of your robot computer. Remember to use the IP address for the network over which you are connecting to the robot. In order for the websocket connection to work and successfully receive the ROS 2 topics, cockpit must be accessed over http, which is an unsecure connection. **Setting up a secure connection over https is currently unsupported**, but contributions are welcome.
4747

48-
3. Go to the ROS 2 Diagnostics tab
48+
3. Go to the ROS 2 Diagnostics tab.
4949

5050
# Development and Source Instructions
5151

@@ -150,7 +150,7 @@ Rules configuration can be found in the `.stylelintrc.json` file.
150150

151151
## Running tests locally
152152

153-
** These tests are still under development **
153+
** **These tests are still under development** **
154154

155155
To run the tests locally you must install:
156156

@@ -180,63 +180,3 @@ It is possible to setup the test environment without running the tests:
180180
You can also run the test against a different Cockpit image, for example:
181181
182182
TEST_OS=fedora-40 make check
183-
184-
## Running tests in CI
185-
186-
These tests can be run in [Cirrus CI](https://cirrus-ci.org/), on their free
187-
[Linux Containers](https://cirrus-ci.org/guide/linux/) environment which
188-
explicitly supports `/dev/kvm`. Please see [Quick
189-
Start](https://cirrus-ci.org/guide/quick-start/) how to set up Cirrus CI for
190-
your project after forking from starter-kit.
191-
192-
The included [.cirrus.yml](./.cirrus.yml) runs the integration tests for two
193-
operating systems (Fedora and CentOS 8). Note that if/once your project grows
194-
bigger, or gets frequent changes, you may need to move to a paid account, or
195-
different infrastructure with more capacity.
196-
197-
Tests also run in [Packit](https://packit.dev/) for all currently supported
198-
Fedora releases; see the [packit.yaml](./packit.yaml) control file. You need to
199-
[enable Packit-as-a-service](https://packit.dev/docs/packit-service/) in your GitHub project to use this.
200-
To run the tests in the exact same way for upstream pull requests and for
201-
[Fedora package update gating](https://docs.fedoraproject.org/en-US/ci/), the
202-
tests are wrapped in the [FMF metadata format](https://github.com/teemtee/fmf)
203-
for using with the [tmt test management tool](https://docs.fedoraproject.org/en-US/ci/tmt/).
204-
Note that Packit tests can *not* run their own virtual machine images, thus
205-
they only run [@nondestructive tests](https://github.com/cockpit-project/cockpit/blob/main/test/common/testlib.py).
206-
207-
## Automated release of tarballs on Github
208-
209-
Once your cloned project is ready for a release, you should consider automating
210-
that. The intention is that the only manual step for releasing a project is to create
211-
a signed tag for the version number, which includes a summary of the noteworthy
212-
changes:
213-
214-
```
215-
123
216-
217-
- this new feature
218-
- fix bug #123
219-
```
220-
221-
Pushing the release tag triggers the [release.yml](.github/workflows/release.yml.disabled)
222-
[GitHub action](https://github.com/features/actions) workflow. This creates the
223-
official release tarball and publishes as upstream release to GitHub. The
224-
workflow is disabled by default -- to use it, edit the file as per the comment
225-
at the top, and rename it to just `*.yml`.
226-
227-
The Fedora and COPR releases are done with [Packit](https://packit.dev/),
228-
see the [packit.yaml](./packit.yaml) control file.
229-
230-
## Automated maintenance
231-
232-
It is important to keep your [NPM modules](./package.json) up to date, to keep
233-
up with security updates and bug fixes. This happens with
234-
[dependabot](https://github.com/dependabot),
235-
see [configuration file](.github/dependabot.yml).
236-
237-
## Further reading
238-
239-
* The [Starter Kit announcement](https://cockpit-project.org/blog/cockpit-starter-kit.html)
240-
blog post explains the rationale for this project.
241-
* [Cockpit Deployment and Developer documentation](https://cockpit-project.org/guide/latest/)
242-
* [Make your project easily discoverable](https://cockpit-project.org/blog/making-a-cockpit-application.html)
26.9 KB
Loading

0 commit comments

Comments
 (0)