Install DumpCat step by step

Linux

Install on a Linux server

1. Open a terminal on the server

   From your own computer, open a terminal (Windows: press Start and type PowerShell; macOS: the Terminal app) and connect to the server:

   TerminalCopy

   ssh user@server-ip

   Replace user and server-ip with the login and address your hosting provider gave you. The first time, answer yes. Many providers also have a Console button in their control panel that opens the same terminal in the browser.

2. Paste this command and press Enter

   bashCopy

   curl -fsSL https://dumpcat.cc/install.sh | sudo sh

   If it asks for a password, type yours: nothing appears on screen while you type, that is normal. The command downloads the latest DumpCat, checks the file, installs it as a service that starts with the server and installs the backup tools that match your database. It takes a minute or two.

3. Note the address and the setup token

   At the end, the installer prints something like this:

   DumpCat is running: http://203.0.113.10:6369/
   No account yet: open the address above and create the admin account.
     The setup page asks for this one-time setup token:  K7QF-2MZD-W9TA-H4NB-X3RC-8PLE

   Lost the token? Run sudo dumpcat setup-token to see it again.

4. Open the address in your browser

   Then follow Open DumpCat for the first time below.

   The page does not load? Port 6369 is blocked. Allow it on the server with sudo ufw allow 6369/tcp (or firewall-cmd --permanent --add-port=6369/tcp && firewall-cmd --reload), and on a cloud server also in the provider's firewall or security group. If you can, allow only your own IP address.

Windows

Install on Windows

1. Download DumpCat for Windows

   Download the .zip

2. Unzip it

   Right-click the downloaded file, choose Extract All…, then Extract. A folder opens.

3. Double-click Install DumpCat

   Windows asks Do you want to allow this app to make changes to your device?: choose Yes.

   If Windows shows Windows protected your PC, click More info, then Run anyway. DumpCat is installed as a Windows service, so it keeps running after you close the window and starts with Windows.

4. Your browser opens DumpCat

   The install window shows the setup token: keep it, the first page asks for it. The address is http://localhost:6369 on this machine. Then follow Open DumpCat for the first time.

irm https://dumpcat.cc/install.ps1 | iex

After installing

Open DumpCat for the first time

1. Create the admin account

   Paste the setup token, choose a user name and a password. You can turn on two-factor sign-in later, under Profile & security.

2. Add your database

   Database servers → Add server. When DumpCat runs on the database server, the host is 127.0.0.1 and the port 3306. Enter a MySQL user and password, then click Test connection: DumpCat shows the databases it sees and any missing privilege.

3. Choose where backups go

   Storage → Add storage. A folder on this machine is the simplest start; Google Drive, OneDrive, S3, SFTP and many more work the same way. Click Test.

4. Create a backup job

   Backup jobs → New job. Pick the database, the schedule and the storage, then Save & run now. The first backup runs at once and is read back to check it.

More detail on every screen: the manual, also inside every download (docs/manual.md).

Downloaded the file already?

Install from the downloaded package

Every package has a START-HERE.txt file with these steps.

tar xzf dumpcat-*-linux.tar.gz
cd dumpcat-*-linux
sudo ./install.sh

Just trying it, without installing?

Run the program straight from the unpacked folder, then open http://localhost:6369. The setup token is printed in the window; Ctrl+C stops it.

./dumpcat-linux-amd64 serve -data-dir ./data

.\dumpcat.exe serve -data-dir .\data

Questions and problems

Still stuck? Write to fat@dumpcat.cc or open an issue on GitHub.