Installation
Let's get you started
Last updated
Let's get you started
Last updated
We want it to be as easy as possible to get started with Cryptitan so we have built an easy to use installer that automatically helps you setup your server and other dependencies such as database, redis, BitGo server, ethereum node, cron jobs, supervisor, nginx, php, websocket service... just to name a few.
To get started you need a VPS Server with nothing installed (i.e. no pre-installed web service) to avoid conflicts with Cryptitan's installer. You can purchase one of these VPS servers using services like or
You will also need to install SSH client like and to connect and upload files to your server. If you are new to connecting and uploading to VPS servers using SSH client, refer to section.
OS: Linux (Ubuntu 18.04 or later)
Architecture: 64bit (x86)
AVX support on CPU
Memory: 8gb+
Storage: 60gb+
Create a new user account on the server, it is under this account, Cryptitan needs to be installed. Do NOT install Cryptitan as root user! You can create a user account using the following command (where 'neoscrypts' is the username):
Our installer leverages the power of container services, so you need to install Docker on the server. (see: )
Don't install Cryptitan as root user!
Navigate to the home directory: i.e. /home/neoscrypts
Upload the zip file obtained from the marketplace to the home directory.
Next, using SSH Terminal, login as the created user account, and navigate to the home directory. i.e. /home/neoscrypts/
Unzip the uploaded source file
Now you should have a folder named: cryptitan-1.0.0.
For convenience sake, rename this folder to just cryptitan
The ending slash "/" of the source and destination directory is required.
The 1.0.0 in the folder name represents the version you are installing.
Verify the folder /home/neoscrypts/cryptitan which should contain all Cryptitan source files.
Don't rename your project folder, after the first build. If you do so, Cryptitan will rebuild on a new instance, similar to a fresh install.
While logged in as the created user account (SSH Terminal), Navigate to the project's folder: i.e. /home/neoscrypts/cryptitan
Create your .env file using the command:
After environment setup, build and start Cryptitan
If the compilation stops with an "unhealthy" message, it means that the environment variables were not properly configured. You will need to stop cryptitan using the command:
./cryptitan stop
You have to check the logs to see the compilation error:
./cryptitan logs -f application
Copy the output of the logs and save in a text file. You should send the text file to us through our support channel. Wewill be able to tell you which one of your environment value was misconfigured.
This will make cryptitan available to the outside world through your domain.
While logged in as the created user account (SSH Terminal). Navigate to the user's home directory: i.e. /home/neoscrypts/
Download the Network tool using the command:
Navigate into the created docker-nginx directory:
Then start up the service:
Cryptitan should now be accessible through your configured domain. (Make sure your domain is already pointed to your server's IP address).
For a complete tutorial on how to connect securely to the newly created user account on your VPS Server via SSH, see: section.
Remember to add the username to the Docker group. (refer to ).
Using your preferred remote file manager (e.g. ), login as the created user account.
If you don't know how to upload files to your VPS server, refer to the section.
Within your project's folder you will find your .env file. Edit the file and set your information as required. Please refer to section for guide.