Setup
When you’ll first install SynBioHub locally and navigate to http://localhost:3333/
, and the setup page will load since you have not completed setup yet.
You will see a welcome message saying, “Congratulations, SynBioHub is successfully installed!”
Then, you need to fill out some details for configuring your local instance, which are as follows:
1. Branding Your SynBioHub
Pick a good Instance Name that describes what the server is. You can pick a logo for the top left of the header, and you can also change the color which will be used to theme most UI elements. Finally you can pick if you want the instance to be pu
2. Technical Details
You can change these, but they should already be prefilled based on your url, so we don’t recommend modifying them. If you are deploying publicly you will need to setup a reverse proxy to host both the frontend and backend at the same url and port.
3. Creating Your First User Account
You need to create a user account that will have the first privileged access to your SynBioHub local instance. For that you need to enter certain details, which are as follows:
Option Name | Description |
---|---|
Full Name | Enter the name of the user |
Affiliation(Optional) | You can enter the name of the university/institute that you’re currently affiliated to |
Email Address | Enter the Email Address, through which you want to get registered. If in future you forget your login credentials, then this shall be used for sending a recovery password for your account |
Username | You have to enter a username of your own choice. This shall be displayed on the record page of every record that you submit |
Password | Enter a password (preferably a strong one) for keeping your user account safe |
All Done
Once, you’ve filled all the details, click continue. This will redirect you to the home page of your SynBioHub local instance.
Next lets get started installing some Plugins!