Skip to content
This repository was archived by the owner on Nov 21, 2025. It is now read-only.

Commit 0a8861a

Browse files
authored
Update index.html.md
remove install section which is in the normal docs
1 parent 2889e84 commit 0a8861a

File tree

1 file changed

+0
-140
lines changed

1 file changed

+0
-140
lines changed

source/index.html.md

Lines changed: 0 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -60,146 +60,6 @@ Web Design
6060

6161
* [Antarctic Design](http://www.antarctic-design.co.uk/)
6262

63-
# Installation
64-
65-
## From Prebuilt Image
66-
### Install Docker
67-
68-
First, install [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/).
69-
70-
Ensure that the Docker daemon is running on your system before continuing. On Mac and Windows, a small whale icon in the system tray indicates Docker is running.
71-
72-
On Ubuntu, start docker using:
73-
74-
```systemctl start docker```
75-
76-
### Starting a SynBioHub Instance
77-
78-
First, pull the docker-compose configuration::
79-
80-
```git clone https://github.com/synbiohub/synbiohub-docker```
81-
82-
Then, start SynBioHub with:
83-
84-
```docker-compose --file ./synbiohub-docker/docker-compose.yml up```
85-
86-
If you would like to start SynBioHub with [SBOLExplorer](https://github.com/SynBioDex/SBOLExplorer) use the following commands instead:
87-
88-
89-
```sysctl -w vm.max_map_count=262144```
90-
91-
``docker-compose --file ./synbiohub-docker/docker-compose.yml --file ./synbiohub-docker/docker-compose.explorer.yml up``
92-
93-
### Configuring
94-
95-
In a web browser, visit
96-
97-
``` http://localhost:7777/ ```
98-
99-
On the first startup, you will be taken to the SynBioHub Setup Page, which enables basic setup of the site. After the first setup, the Admin Portal will allow admin users to update their site configuration.
100-
101-
### SendGrid email setup
102-
In order to enable SynBioHub to send account-related emails, you need a [SendGrid](https://sendgrid.com/) account and API key. Once you have created your account, you should click "Settings" in the left bar, then "API Keys". On the resulting page, click the "Create API Key" button in the upper-right corner, and give your new API key a name. You should see the key on the next page. Copy the key and paste it into the "SendGrid API Key" in the Mail page on the SynBioHub admin dashboard. Save the API key in SynBioHub and you are ready to begin sending email.
103-
104-
### Updating
105-
106-
To update a container, pull the new version and start it.
107-
108-
```cd synbiohub-docker```
109-
110-
``` git pull ```
111-
112-
``` cd .. ```
113-
114-
``` ## if you are not running SBOL Explorer ```
115-
116-
``` docker-compose --file synbiohub-docker/docker-compose.yml pull synbiohub ```
117-
118-
```docker-compose --file synbiohub-docker/docker-compose.yml up ```
119-
120-
``` ## If you are running SBOL Explorer: ```
121-
122-
``` docker-compose --file synbiohub-docker/docker-compose.yml --file synbiohub-docker/docker-compose.explorer.yml pull synbiohub ```
123-
124-
``` docker-compose --file synbiohub-docker/docker-compose.yml --file synbiohub-docker/docker-compose.explorer.yml up ```
125-
126-
###### PERSISTENT LOGS UPDATE
127-
128-
If you are updating from a version earlier than 1.5.2, then you must execute the following command to setup persistent log files:
129-
130-
```docker exec -it synbiohub-docker_synbiohub_1 mkdir /mnt/data/logs ```
131-
132-
#### If you are updating from a version of SynBioHub earlier than 1.3.0 to 1.3.0 or later, you must execute the following steps to persist your data between instances! ####
133-
134-
``` docker exec synbiohub cp /opt/synbiohub/synbiohub.sqlite /mnt/data/synbiohub.sqlite ```
135-
136-
``` docker exec synbiohub cp -R /opt/synbiohub/uploads /mnt/data/uploads ```
137-
138-
``` docker exec synbiohub chown synbiohub /mnt/data/synbiohub.sqlite ```
139-
140-
``` docker exec synbiohub chgrp synbiohub /mnt/data/synbiohub.sqlite ```
141-
142-
``` docker exec synbiohub chown -R synbiohub /mnt/data/uploads ```
143-
144-
``` docker exec synbiohub chgrp -R synbiohub /mnt/data/uploads ```
145-
146-
To update to the latest version of SynBioHub, first stop and remove the container:
147-
148-
``` docker stop synbiohub ```
149-
150-
``` docker rm synbiohub ```
151-
152-
Then pull the latest version:
153-
154-
``` docker pull synbiohub/synbiohub:1.3.0 ```
155-
156-
Finally, run a new container with the latest image:
157-
158-
``` docker run -v synbiohub:/mnt -p 7777:7777 --name synbiohub -d synbiohub/synbiohub:1.3.0 ```
159-
160-
## From Source
161-
162-
Follow the instructions on the [GitHub README](https://github.com/synbiohub/synbiohub) to install SynBioHub locally on your system. If you would like SynBioHub to run as a service, you can enable Virtuoso using systemd or open a virtual terminal using tmux or GNU screen and run
163-
164-
``` sudo /usr/local/bin/virtuoso-t +configfile $YOUR_CONFIG_FILE ```
165-
166-
You should also run SynBioHub as a system service or using a virtual terminal and the command
167-
168-
``` npm start ```
169-
170-
If you are doing development work, you can start SynBioHub with the command
171-
172-
``` npm run-script dev ```
173-
174-
which will restart the application with any change to the JavaScript source.
175-
176-
## NGINX configuration
177-
178-
Instructions for managing nginx server blocks can be found [here](https://www.digitalocean.com/community/tutorials/how-to-set-up-nginx-server-blocks-virtual-hosts-on-ubuntu-16-04#step-three-create-server-block-files-for-each-domain).
179-
180-
The server block for a SynBioHub installation listening on port 7777 is to the right
181-
182-
```
183-
client_max_body_size 800m;
184-
proxy_connect_timeout 6000;
185-
proxy_send_timeout 6000;
186-
proxy_read_timeout 6000;
187-
send_timeout 6000;
188-
server {
189-
listen 80;
190-
server_name _;
191-
192-
location / {
193-
proxy_set_header X-Real-IP $remote_addr;
194-
proxy_set_header X-Forwarded-Server $host;
195-
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
196-
proxy_set_header Host $host;
197-
proxy_pass http://127.0.0.1:7777$request_uri;
198-
}
199-
}
200-
```
201-
This is most useful when you would like to host SynBioHub on a subdomain alongside other content (using nginx as an HTTP proxy) or using HTTPS.
202-
20363
# User Endpoints
20464

20565
Endpoints that control user related functions

0 commit comments

Comments
 (0)