Skip to content

Commit 98aa806

Browse files
committed
Documented start&stop
1 parent b3fefbd commit 98aa806

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Changes from version 0.7.2 to master
2+
3+
- Added `start` command to run starter in detached mode.
4+
- Added `stop` command to stop a running starter using its HTTP API.
5+
16
# Changes from version 0.7.1 to 0.7.2
27

38
- Added path containing starter executable to search path for `arangod`.

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,31 @@ docker run -it --name=adb --rm -p 8528:8528 \
145145
--starter.mode=single
146146
```
147147

148+
Starting & stopping in detached mode
149+
------------------------------------
150+
151+
If you want the starter to detach and run as a background process, use the `start`
152+
command. This is typically used by developers running tests only.
153+
154+
```
155+
arangodb start --starter.local=true [--starter.wait]
156+
```
157+
158+
This command will make the starter run another starter process in the background
159+
(that starts all ArangoDB servers), wait for it's HTTP API to be available and
160+
then exit. The starter that was started in the background will keep running until you stop it.
161+
162+
The `--starter.wait` option makes the `start` command wait until all ArangoDB server
163+
are really up, before ending the master process.
164+
165+
To stop a starter use this command.
166+
167+
```
168+
arangodb stop
169+
```
170+
171+
Make sure to match the arguments given to start the starter (`--starter.port` & `--ssl.*`).
172+
148173
Common options
149174
--------------
150175

0 commit comments

Comments
 (0)