Quick Start

To run Archivist through this guide we would need to perform the following steps:

• Review the disclaimer
• Get Archivist binary
• Run Archivist
• Interact with Archivist

Get Archivist binary

For quick a start we will use precompiled binaries from GitHub release page. If you prefer to compile from the sources, please check Build Archivist.

Please follow the steps for your OS from the list:

• Linux/macOS
• Windows

Linux/macOS

1. Install latest Archivist release

   curl -s https://get.archivist.storage/install.sh | bash

2. Install dependencies

   # Debian-based Linux
   sudo apt update && sudo apt install libgomp1

3. Check the result

   archivist --version

Windows

1. Install latest Archivist release

    curl -sO https://get.archivist.storage/install.cmd && install.cmd

   WARNING

   Windows antivirus software and built-in firewalls may cause steps to fail. We will cover some possible errors here, but always consider checking your setup if requests fail - in particular, if temporarily disabling your antivirus fixes it, then it is likely to be the culprit.

   If you see an error like:

   curl: (35) schannel: next InitializeSecurityContext failed: CRYPT_E_NO_REVOCATION_CHECK (0x80092012) - The revocation function was unable to check revocation for the certificate.

   You may need to add the --ssl-no-revoke option to your curl calls, i.e., modify the calls above so they look like this:

    curl -LO --ssl-no-revoke https://...

2. Update path using console output

   • Current session only

     :: Default installation directory
     set "PATH=%PATH%%LOCALAPPDATA%\Archivist;"

   • Update PATH permanently

     • Control Panel --> System --> Advanced System settings --> Environment Variables
     • Alternatively, type environment variables into the Windows Search box

3. Check the result

   archivist --version

Run Archivist

We may run Archivist in different modes, and for a quick start we will run Archivist node, to be able to share files in the network.

1. Run Archivist

   Linux/macOS

   archivist \
     --data-dir=datadir \
     --disc-port=8090 \
     --listen-addrs=/ip4/0.0.0.0/tcp/8070 \
     --nat=any \
     --api-cors-origin="*" \
     --bootstrap-node=spr:CiUIAhIhA5mg11LZgFQ4XzIRb1T5xw9muFW1ALNKTijyKhQmvKYXEgIDARpJCicAJQgCEiEDmaDXUtmAVDhfMhFvVPnHD2a4VbUAs0pOKPIqFCa8phcQl-XFxQYaCwoJBE4vqKqRAnU6GgsKCQROL6iqkQJ1OipHMEUCIQDfzVYbN6A_O4i29e_FtDDUo7GJS3bkXRQtoteYbPSFtgIgcc8Kgj2ggVJyK16EY9xi4bY2lpTTeNIRjvslXSRdN5w

   Windows

   WARNING

   Windows might at this stage prompt you to grant internet access to Archivist. You must allow it for things to work. It also might be required to add incoming firewall rules for Archivist and we can use netsh utility.

   add firewall rules using netsh

   :: Add rules
   netsh advfirewall firewall add rule name="Allow Archivist (TCP-In)" protocol=TCP dir=in localport=8070 action=allow
   netsh advfirewall firewall add rule name="Allow Archivist (UDP-In)" protocol=UDP dir=in localport=8090 action=allow
   
   :: List rules
   netsh advfirewall firewall show rule name=all | find /I "Archivist"
   
   :: Delete rules
   netsh advfirewall firewall delete rule name="Allow Archivist (TCP-In)"
   netsh advfirewall firewall delete rule name="Allow Archivist (UDP-In)"

   :: Run Archivist
   archivist ^
     --data-dir=datadir ^
     --disc-port=8090 ^
     --listen-addrs=/ip4/0.0.0.0/tcp/8070 ^
     --nat=any ^
     --api-cors-origin="*" ^
     --bootstrap-node=spr:CiUIAhIhA5mg11LZgFQ4XzIRb1T5xw9muFW1ALNKTijyKhQmvKYXEgIDARpJCicAJQgCEiEDmaDXUtmAVDhfMhFvVPnHD2a4VbUAs0pOKPIqFCa8phcQl-XFxQYaCwoJBE4vqKqRAnU6GgsKCQROL6iqkQJ1OipHMEUCIQDfzVYbN6A_O4i29e_FtDDUo7GJS3bkXRQtoteYbPSFtgIgcc8Kgj2ggVJyK16EY9xi4bY2lpTTeNIRjvslXSRdN5w

   TIP

   In the example above we use Archivist Testnet bootstrap nodes and thus we join Testnet. If you would like to join a different network, please use appropriate value.

2. Configure port-forwarding for the TCP/UDP ports on your Internet router

   Protocol	Service	Port
   UDP	Discovery	8090
   TCP	Transport	8070

If you would like to purchase or sell storage, please consider to run Archivist node with marketplace support or Archivist storage node.

Interact with Archivist

When your Archivist node is up and running you can interact with it using Archivist App UI for files sharing.

Also, you can interact with Archivist using Archivist API and for a walk-through of the API, consider following the Using Archivist guide.

Stay in touch

Want to stay up-date, or looking for further assistance? Try our discord-server.

Ready to explore Archivist functionality? Please Join Archivist Testnet.

If you want to run Archivist locally without joining the Testnet, consider trying the Archivist Two-Client Test or the Running a Local Archivist Network with Marketplace Support.