Skip to content

Commit 3a23250

Browse files
committed
README.md update
1 parent 10faf2d commit 3a23250

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,33 @@ the [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-sonar
2626
🚀 Getting Started
2727
------------------
2828

29-
check [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-getting-started)
29+
You can give a try with a one command docker :
30+
31+
```sh
32+
docker run -ti --rm \
33+
-p 9000:9000 \
34+
--name sonarqube-ecocode-java ghcr.io/green-code-initiative/sonarqube-ecocode-java:latest
35+
```
36+
37+
or (with logs and data locally stored) :
38+
39+
```sh
40+
docker run -ti --rm \
41+
-v sq_ecocode_logs:/opt/sonarqube/logs \
42+
-v sq_ecocode_data:/opt/sonarqube/data \
43+
-p 9000:9000 \
44+
--name sonarqube-ecocode-java ghcr.io/green-code-initiative/sonarqube-ecocode-java:latest
45+
```
46+
47+
... and configure local SonarQube (security config and quality profile : see [configuration](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/INSTALL.md#configuration-sonarqube) for more details).
48+
49+
To install other `ecocode` plugins, you can also :
50+
- download each plugin separatly and copy the plugin (jar file) to `$SONAR_INSTALL_DIR/extensions/plugins` and restart SonarQube.
51+
- install different ecocode plugins with Marketplace (inside admin panel of SonarQube)
52+
53+
Then you can use Java test project repository to test the environment : see README.md of [Java test project](https://github.com/green-code-initiative/ecoCode-java-test-project)
54+
55+
Finally, you can directly use a [all-in-one docker-compose](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/INSTALL.md#start-sonarqube-if-first-time)
3056

3157
🛒 Distribution
3258
------------------

0 commit comments

Comments
 (0)