Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
4f87075b
Commit
4f87075b
authored
Jul 12, 2019
by
Evan Read
Committed by
Achilleas Pipinellis
Jul 12, 2019
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Remove <pre> tag and other fixes
parent
a296ae99
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
25 additions
and
24 deletions
+25
-24
doc/administration/integration/plantuml.md
doc/administration/integration/plantuml.md
+25
-24
No files found.
doc/administration/integration/plantuml.md
View file @
4f87075b
# PlantUML & GitLab
# PlantUML & GitLab
> [Introduced][ce-8537] in GitLab 8.16.
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537) in
> GitLab 8.16.
When
[
PlantUML
](
http://plantuml.com
)
integration is enabled and configured in
When
[
PlantUML
](
http://plantuml.com
)
integration is enabled and configured in
GitLab we are able to create simple diagrams in AsciiDoc and Markdown documents
GitLab we are able to create simple diagrams in AsciiDoc and Markdown documents
...
@@ -15,7 +16,9 @@ server that will generate the diagrams.
...
@@ -15,7 +16,9 @@ server that will generate the diagrams.
With Docker, you can just run a container like this:
With Docker, you can just run a container like this:
`docker run -d --name plantuml -p 8080:8080 plantuml/plantuml-server:tomcat`
```
sh
docker run
-d
--name
plantuml
-p
8080:8080 plantuml/plantuml-server:tomcat
```
The
**PlantUML URL**
will be the hostname of the server running the container.
The
**PlantUML URL**
will be the hostname of the server running the container.
...
@@ -26,7 +29,7 @@ own PlantUML server is easy in Debian/Ubuntu distributions using Tomcat.
...
@@ -26,7 +29,7 @@ own PlantUML server is easy in Debian/Ubuntu distributions using Tomcat.
First you need to create a
`plantuml.war`
file from the source code:
First you need to create a
`plantuml.war`
file from the source code:
```
```
sh
sudo
apt-get
install
graphviz openjdk-8-jdk git-core maven
sudo
apt-get
install
graphviz openjdk-8-jdk git-core maven
git clone https://github.com/plantuml/plantuml-server.git
git clone https://github.com/plantuml/plantuml-server.git
cd
plantuml-server
cd
plantuml-server
...
@@ -36,7 +39,7 @@ mvn package
...
@@ -36,7 +39,7 @@ mvn package
The above sequence of commands will generate a WAR file that can be deployed
The above sequence of commands will generate a WAR file that can be deployed
using Tomcat:
using Tomcat:
```
```
sh
sudo
apt-get
install
tomcat7
sudo
apt-get
install
tomcat7
sudo cp
target/plantuml.war /var/lib/tomcat7/webapps/plantuml.war
sudo cp
target/plantuml.war /var/lib/tomcat7/webapps/plantuml.war
sudo chown
tomcat7:tomcat7 /var/lib/tomcat7/webapps/plantuml.war
sudo chown
tomcat7:tomcat7 /var/lib/tomcat7/webapps/plantuml.war
...
@@ -46,7 +49,7 @@ sudo service tomcat7 restart
...
@@ -46,7 +49,7 @@ sudo service tomcat7 restart
Once the Tomcat service restarts the PlantUML service will be ready and
Once the Tomcat service restarts the PlantUML service will be ready and
listening for requests on port 8080:
listening for requests on port 8080:
```
```
text
http://localhost:8080/plantuml
http://localhost:8080/plantuml
```
```
...
@@ -57,9 +60,10 @@ you can change these defaults by editing the `/etc/tomcat7/server.xml` file.
...
@@ -57,9 +60,10 @@ you can change these defaults by editing the `/etc/tomcat7/server.xml` file.
You need to enable PlantUML integration from Settings under Admin Area. To do
You need to enable PlantUML integration from Settings under Admin Area. To do
that, login with an Admin account and do following:
that, login with an Admin account and do following:
-
in GitLab go to
**Admin Area**
->
**Settings**
->
**Integrations**
->
**PlantUML**
-
In GitLab, go to
**Admin Area > Settings > Integrations**
.
-
check
**Enable PlantUML**
checkbox
-
Expand the
**PlantUML**
section.
-
set the PlantUML instance as
**PlantUML URL**
-
Check
**Enable PlantUML**
checkbox.
-
Set the PlantUML instance as
**PlantUML URL**
.
## Creating Diagrams
## Creating Diagrams
...
@@ -68,7 +72,6 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
...
@@ -68,7 +72,6 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
-
**Markdown**
-
**Markdown**
<pre>
````
markdown
````
markdown
```
plantuml
```
plantuml
Bob -> Alice : hello
Bob -> Alice : hello
...
@@ -78,7 +81,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
...
@@ -78,7 +81,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
-
**AsciiDoc**
-
**AsciiDoc**
```
```
text
[plantuml, format="png", id="myDiagram", width="200px"]
[plantuml, format="png", id="myDiagram", width="200px"]
----
----
Bob->Alice : hello
Bob->Alice : hello
...
@@ -88,7 +91,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
...
@@ -88,7 +91,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks:
-
**reStructuredText**
-
**reStructuredText**
```
```
text
.. plantuml::
.. plantuml::
:caption: Caption with **bold** and *italic*
:caption: Caption with **bold** and *italic*
...
@@ -120,5 +123,3 @@ Some parameters can be added to the AsciiDoc block definition:
...
@@ -120,5 +123,3 @@ Some parameters can be added to the AsciiDoc block definition:
-
*height*
: Height attribute added to the img tag.
-
*height*
: Height attribute added to the img tag.
Markdown does not support any parameters and will always use PNG format.
Markdown does not support any parameters and will always use PNG format.
[
ce-8537
]:
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment