Skip to content

Commit 7bdc10c

Browse files
author
reger
committed
added Windows Service installer
- used Apache procrun as it has a small footprint and comes with a GUI to edit the service settings see http://commons.apache.org/proper/commons-daemon/procrun.html - added the service runner exe file under addon/windowsService as is (without renaming the exe files) - included installYaCyWindowsService.bat and uninstallYaCyWindowsService.bat to main directory - which chooses the native exe according to the processor_architecture
1 parent e05320b commit 7bdc10c

9 files changed

+408
-0
lines changed

‎addon/windowsService/LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎addon/windowsService/NOTICE.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Apache Commons Daemon
2+
Copyright 1999-2013 The Apache Software Foundation
3+
4+
This product includes software developed by
5+
The Apache Software Foundation (http://www.apache.org/).

‎addon/windowsService/RELEASE-NOTES.txt

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
Apache Commons Daemon
2+
Version 1.0.15
3+
Release Notes
4+
5+
6+
INTRODUCTION:
7+
8+
Apache Commons Daemon is a set of utilities and Java support classes
9+
for running Java applications as server processes.
10+
Commonly known as 'daemon' processes in Unix terminology (hence the name),
11+
on Windows they are called 'services'.
12+
13+
This document contains the release notes for this version of the
14+
Apache Commons Daemon package, and highlights changes since
15+
the previous version.
16+
The current release adds new features and bug fixes, and is being done now
17+
to follow the release early/release often mentality.
18+
19+
20+
Compatibility with 1.0.3
21+
------------------------
22+
Binary compatible - Yes
23+
24+
Source compatible - Yes
25+
26+
Semantic compatible - Yes
27+
28+
Commons DAEMON 1.0.3 requires a minimum of JDK 1.3
29+
30+
31+
NEW FEATURES:
32+
33+
* DAEMON-269: Support privilege escalation on Windows UAC for procmgr (1.0.12)
34+
* DAEMON-264: Add -cwd to jsvc so that user can specify working
35+
directory. It defaults to /. (1.0.11)
36+
* DAEMON-262: Automatically refresh manager application (1.0.11)
37+
* DAEMON-245: Support privilege escalation on Windows UAC (1.0.11)
38+
* DAEMON-221: Add -umask to jsvc so that users don't have to
39+
recompile the jsvc if different umask is desired (1.0.8)
40+
* DAEMON-209: Add --LibraryPath to procrun for setting the
41+
LoadLibrary search paths (1.0.6)
42+
* DAEMON-208: Add -server and -client -jvm <name> synonyms (1.0.6)
43+
* DAEMON-205: Add support for building on ARM processors (1.0.6)
44+
* DAEMON-204: Add DaemonSignal interface that allows catching SIGUSR2
45+
signals and creating custom callbacks (1.0.6)
46+
* DAEMON-202: Allow JSVC_OPTS environment variable to be used in
47+
the example Tomcat scripts (1.0.6)
48+
* DAEMON-180: Add DaemonWrapper to allow running standard applications
49+
as daemons. (1.0.4)
50+
* DAEMON-179: Allow procrun to use java/lang/System as --ShutdownClass. (1.0.4)
51+
* DAEMON-178: Allow jsvc umask to be configured at build time
52+
* DAEMON-177: Allow fail during init with nicer message. (1.0.4)
53+
* DAEMON-176: Create config.nice during configure step. (1.0.4)
54+
* DAEMON-173: Allow --JavaHome=jdk and --JavaHome=jre options that
55+
will guess default JavaHome from the registry. (1.0.4)
56+
* DAEMON-160: Remove obsolete code; rename native/nt as native/windows (1.0.4)
57+
* DAEMON-144: Drop sample dependency on Commons Collections ExtendedProperties (1.0.4)
58+
* DAEMON-95: Support log rotation using SIGUSR1 (1.0.4)
59+
* DAEMON-80: Syslog support for jsvc (1.0.4)
60+
61+
* DAEMON-138: Add --PidFile option to allow storing running process id. (1.0.3)
62+
* DAEMON-137: Add --LogJniMessages allowing to configure JNI verbose message
63+
logging. By default those messages were always logged. (1.0.3)
64+
* DAEMON-140: Add missing Java6 parameters -ea, da, -esa, -dsa, -showversion
65+
and their long name synonyms. (1.0.3)
66+
* DAEMON-142: Add option to display procrun version. (1.0.3)
67+
* DAEMON-166: Add classpath .jar expansion. If the classpath
68+
element ends with asterisk it will evaluate to all .jar files
69+
found in the path. (1.0.3)
70+
71+
* Add -wait and -stop parameters. (1.0.1).
72+
The -wait parameter is experimental: that a is loop testing for a
73+
file in /tmp and waiting n/10 seconds.
74+
75+
* Allow to run as normal user for testing. (1.0.1).
76+
77+
* Initial import to Commons, including the daemon Java API, and jsvc
78+
for Unix and Windows NT/2K/XP, which allows running a Java program
79+
as a native operating system daemon
80+
81+
* Switch to JIRA bug tracking system.
82+
83+
* Add sample ProcrunService Java application for use with Procrun Jvm/Java modes (1.0.3)
84+
85+
BUG FIXES:
86+
87+
1.0.15: DAEMON-288, DAEMON-289, DAEMON-291, DAEMON-292
88+
89+
1.0.14: DAEMON-278, DAEMON-280, DAEMON-281, DAEMON-283, DAEMON-284, DAEMON-286,
90+
DAEMON-287
91+
92+
1.0.13: DAEMON-275, DAEMON-276
93+
94+
1.0.12: DAEMON-268, DAEMON-272, DAEMON-274
95+
96+
1.0.11: DAEMON-244, DAEMON-246, DAEMON-247, DAEMON-252, DAEMON-253, DAEMON-254,
97+
DAEMON-255, DAEMON-257, DAEMON-261, DAEMON-263, DAEMON-265, DAEMON-266,
98+
DAEMON-267
99+
100+
1.0.10: DAEMON-241, DAEMON-242
101+
102+
1.0.9: DAEMON-232, DAEMON-233, DAEMON-234, DAEMON-237, DAEMON-240
103+
104+
1.0.8: DAEMON-195, DAEMON-215, DAEMON-216, DAEMON-218, DAEMON-219, DAEMON-220,
105+
DAEMON-222, DAEMON-223, DAEMON-224, DAEMON-227, DAEMON-228
106+
107+
1.0.7: DAEMON-211, DAEMON-214
108+
109+
1.0.6: DAEMON-186, DAEMON-193, DAEMON-194, DAEMON-206, DAEMON-185, DAEMON-200
110+
DAEMON-192
111+
112+
1.0.5: DAEMON-158, DAEMON-184, DAEMON-187, DAEMON-188, DAEMON-190
113+
114+
1.0.4: DAEMON-95, DAEMON-171, DAEMON-100, DAEMON-164, DAEMON-165, DAEMON-175,
115+
DAEMON-177, DAEMON-150, DAEMON-163, DAEMON-182, DAEMON-181
116+
117+
1.0.3: DAEMON-108, DAEMON-128, DAEMON-139, DAEMON-143, DAEMON-148,
118+
DAEMON-135, DAEMON-155, DAEMON-159, DAEMON-161, DAEMON-145, DAEMON-146,
119+
DAEMON-167, DAEMON-168, DAEMON-154, DAEMON-149
120+
121+
1.0.2: DAEMON-16, DAEMON-31, DAEMON-40, DAEMON-45, DAEMON-49, DAEMON-60,
122+
DAEMON-84, DAEMON-90, DAEMON-91, DAEMON-92, DAEMON-93, DAEMON-94,
123+
DAEMON-96, DAEMON-97, DAEMON-98, DAEMON-102, DAEMON-105, DAEMON-106,
124+
DAEMON-110, DAEMON-112, DAEMON-113, DAEMON-114, DAEMON-115, DAEMON-116,
125+
DAEMON-117, DAEMON-118, DAEMON-119, DAEMON-120, DAEMON-121, DAEMON-123,
126+
DAEMON-124, DAEMON-125, DAEMON-126, DAEMON-129, DAEMON-130, DAEMON-132,
127+
DAEMON-133
128+
129+
1.0.1: 304310, 30177, 27523, 29465, 31614, 33580, 31613, 34851.
130+
131+
Feedback
132+
--------
133+
Open source works best when you give feedback:
134+
http://commons.apache.org/daemon/
135+
136+
Please direct all bug reports to JIRA
137+
https://issues.apache.org/jira/browse/DAEMON
138+
139+
Or subscribe to the commons-user mailing list (prefix emails by [daemon])
140+
http://commons.apache.org/mail-lists.html
141+
142+
The Apache Commons Daemon Team

‎addon/windowsService/amd64/prunsrv.exe

102 KB
Binary file not shown.

‎addon/windowsService/ia64/prunsrv.exe

204 KB
Binary file not shown.

‎addon/windowsService/prunmgr.exe

102 KB
Binary file not shown.

‎addon/windowsService/prunsrv.exe

79 KB
Binary file not shown.

‎installYaCyWindowsService.bat

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
@Echo Off
2+
title YaCy Windows Service Install
3+
4+
:STARTJAVA
5+
REM set the Java options
6+
set javaopts=-Xss256k;-XX:MaxPermSize=256m;-XX:-UseGCOverheadLimit;-XX:+UseAdaptiveSizePolicy;-Djava.net.preferIPv4Stack=true;-Djava.awt.headless=true;-Dfile.encoding=UTF-8
7+
8+
REM set max Java heap memory (in MB)
9+
set jmx=800
10+
set jms=180
11+
set servicedesc="P2P SearchEngine"
12+
13+
Rem This target is used to read java runtime parameters out of the yacy config file
14+
:GETSTARTOPTS
15+
REM for /F "tokens=1,2 delims==" %%i in (DATA\SETTINGS\yacy.conf) do (
16+
REM if "%%i"=="javastart_Xmx" set jmx=%%j
17+
REM if "%%i"=="javastart_Xms" set jms=%%j
18+
REM )
19+
20+
Rem choose service runner executable according to processor architecture
21+
set exepath=addon\windowsService
22+
if /I "%PROCESSOR_ARCHITECTURE%"=="AMD64" set exepath=addon\windowsService\amd64
23+
if /I "%PROCESSOR_ARCHITECTURE%"=="IA64" set exepath=addon\windowsService\ia64
24+
25+
Echo JRE Parameters:%javacmd%
26+
Echo Startpath %~dp0
27+
28+
REM Install YaCy as Windows Service
29+
%exepath%\prunsrv.exe //IS//YaCy --Jvm=auto --StartMode=jvm --StartClass=net.yacy.yacy --Classpath=htroot;lib/yacycore.jar --StartPath=%~dp0 --JvmOptions=%javaopts% --Startup=auto --JvmMx=%jmx% --JvmMs=%jms% --StopMode=jvm --StopClass=net.yacy.yacy --StopParams=-shutdown --Description=%servicedesc%
30+
31+
if not errorlevel 1 goto installed
32+
echo Failed installing '%SERVICE_NAME%' service
33+
goto end
34+
35+
:installed
36+
REM Start Service manager to check/edit YaCy Service settings
37+
REM start addon\windowsService\prunmgr.exe //ES//YaCy
38+
39+
Echo start the YaCy service
40+
%exepath%\prunsrv.exe //ES//YaCy
41+
42+
Echo wait some seconds for YaCy to startup
43+
timeout /T 10
44+
explorer http://localhost:8090/
45+
46+
:end

0 commit comments

Comments
 (0)