Skip to content

Commit 47579cc

Browse files
committed
Adding docs for name-delegation in #250
1 parent 37d0f44 commit 47579cc

File tree

2 files changed

+56
-1
lines changed

2 files changed

+56
-1
lines changed

src/sphinx/DetailedTopics/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ Advanced Topics
1212
redhat.rst
1313
debian.rst
1414
windows.rst
15-
docker.rst
15+
docker.rst
16+
paths.rst

src/sphinx/DetailedTopics/paths.rst

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
Path Configurations
2+
===================
3+
This section describes where and how to configure different kind of paths settings.
4+
5+
- What is the installation location of my package
6+
- Where is the log directory created
7+
- What is the name of my start script
8+
- ...
9+
10+
11+
12+
Quick Reference Table
13+
---------------------
14+
This table gives you a quick overview of the setting and the scope you should use.
15+
Paths which do not begin with a ``/`` are relative to the universal directory.
16+
17+
======================================================== =================== ===================== =======
18+
output path scopes archetype comment
19+
======================================================== =================== ===================== =======
20+
lib all JavaApp
21+
conf all JavaApp
22+
bin/``<packageName>`` Global, Debian, Rpm JavaApp
23+
bin/``<packageName>`` Docker Entrypoint DockerPlugin
24+
bin/``<packageName>``.bat Global JavaApp
25+
``<defaultLinuxInstallationLocation>``/``<packageName>`` Linux, Debian, Rpm JavaApp
26+
``<defaultLinuxLogLocation>``/``<packageName>`` Linux JavaServerApplication
27+
logs Linux JavaServerApplication Symlink
28+
/etc/default/``<packageName>`` Linux JavaServerApplication
29+
/var/run/``<packageName>`` Linux JavaServerApplication
30+
/etc/init.d/``<packageName>`` Linux, Debian, Rpm JavaServerApplication For SystemV
31+
/etc/init/``<packageName>`` Linux, Debian, Rpm JavaServerApplication For Upstart
32+
/usr/lib/systemd/system/``<packageName>``.service Linux, Debian, Rpm JavaServerApplication For Systemd
33+
``<defaultLinuxInstallLocation>`` Global, Docker Installation path inside the container
34+
======================================================== =================== ===================== =======
35+
36+
37+
38+
39+
40+
41+
Settings
42+
--------
43+
44+
Debian requires the following specific settings:
45+
46+
``name``
47+
Use for the normal jar generation process
48+
49+
``normalizedName``
50+
Use for the normal jar generation process.
51+
52+
``packageName``
53+
Defaults to ``normalizedName``. Can be override in different scopes
54+

0 commit comments

Comments
 (0)