Skip to content

Commit 6d2ebb3

Browse files
author
Tom Aalbers
committed
Update README.md
1 parent cac2092 commit 6d2ebb3

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# mass-smuggler
2-
RavenDB Mass Smuggler - Simple tool for backing up all RavenDB databases.
2+
RavenDB Mass Smuggler - Simple tool for exporting all RavenDB databases with one command.
3+
4+
# Getting started
5+
6+
- Download the files in de `dist` folder and save them on your machine/server.
7+
- Navigate to the folder where you placed the files via your terminal.
8+
- Enter the commands to use the mass smuggler.
9+
10+
# Commands
11+
12+
```
13+
# Export all databases
14+
Command: Mass.Smuggler.exe --export --all --url <url Raven Database server> --path <path to save export files too>
15+
Example: Mass.Smuggler.exe --export --all --url http://localhost:8080 --path c:\backups\
16+
17+
# Help information
18+
Command: Mass.Smuggler.exe --help
19+
Example output:
20+
21+
Export
22+
--export : [required] Export database(s)
23+
--all : [required] Select all databases
24+
--url <value> : [required] Raven DB server instance URL
25+
--path <value> : [required] Ravendump files destination path
26+
27+
Other
28+
--help : Show helping information
29+
```

0 commit comments

Comments
 (0)