|
Quickstart Installation Instructions
If you want to install the code quickly, click on this link. It will launch the current version of the code using Java Web Start. You should see a window similar to what is below. This window runs a Tranche server locally on your computer and lets you manage it using a graphical user interface (GUI). If for some reason the above link doesn't work, make sure that you have a current version of Java installed on your computer.
To start the server, first select "Server Configuration" from the "Preferences" menu located at the top of the application. The default port used is 443. You can change this to any port you like, and you can optionally toggle the 'SSL' box to tunnel traffic via SSL for encryption, at the expense of notably more CPU cycles. When you are finished making changes click, "Start the Server".
If you'd like to play around with the server, you should set yourself as an administrator. As an aside, this will be done automatically each time a user starts a new server.
Testing out your server
After setting up a new server it is recommended that you test it out. You should try to both upload and download content directly to your server. You can find your server's URL in the startup message displayed in the GUI.
Expect the server's URL to be similar to "tranche://192.168.0.103:443". The URL will change to use the IP address of your computer and the port you've selected. If you can't find the URL, make sure you've clicked the "Start Server" button located in the "Server Configuartion" section under "Preferences". Throughout the following text replace any instance of this URL with the one from your server.
Note: if your computer is on a local network, e.g. any IP address that starts with 192.168, then you may not be able to use your computer as a node in the ProteomeCommons.org Tranche network. These IP addresses do not work outside of your local network, and computers outside your network cannot use the address to contact your computer. If you'd like a non-local IP address you can talk to your network administrator. A local IP address will work fine for the rest of this example.
Launch the Add File Tool to add some files to your server. When the tool loads enter the following information.
- The file, or directory of files, that you'd like to upload. Pick any relatively small file or directory for this example.
- Your user file that contains both your X.509 certificate and your private key.
- Your server's URL, e.g. tranche://192.168.0.103:443, In order to select your server you must first select "Configuration" from the "Options" menu located at the top of the uploader application tool, and then select only your server from the list.
When you are done, the Add File Tool should look similar to the following.
Click on the "Upload File(s)" button to add the file or directory of files. A progress bar will appear and when the upload is complete a hash string will be presented.
Now launch the Get File Tool to download the files from the server. When the tool loads enter the following information.
- The hash, which identifier that the upload tool provided following the upload
- Your server's URL, e.g. tranche://192.168.0.103:443, again in order to select your server you must first select "Configuration" from the "Options" menu located at the top of the downloader application tool, and then select only your server from the list.
Here's a sample hash:
Click on the "Download File(s)" button to download your files. You'll get to choose where the files are downloaded. Make sure that you specify an existing directory if you are downloading more than one file. Next, a progress bar will appear that shows both the download of the files and the verification that the exact data was downloaded. Congratulations! You have just set up a Tranche server and verified that it is in working order. What now? Keep a copy of your user file and use it to upload data from any other computer to yours. You can also give the hash codes that the Add File Tool creates to anyone who wants to download your data.