Differences

This shows you the differences between two versions of the page.

--- tutorial_en_ffplugin [2012/11/19 00:47] – created xirvdev
+++ tutorial_en_ffplugin [2012/11/27 06:40] – xirvdev
@@ Line 1: / Line 1: @@
-Firefox Plugin Tutorial
+====== Firefox Plugin Tutorial ======
 We've put together a great little FireFox plugin that will make torrenting way easier.
@@ Line 14: / Line 15: @@
 First step is to select Tools > Configure Xirvik seedbox from the top bar in your browser.
+\\ {{:fftut.png|}}
 If you are on a more recent version of FireFox (4.0+), then it's a little different.
 First, access the Add-on manager (shortcut: Ctrl+Shift+A) by finding the orange box to the upper left and choosing Add-ons from the drop-down menu.
+\\ {{:fftut15.png|}}
 An entry in the Add-on manager will look something like what you see below.
-We will select Options to configure the plugin.
+We will select **Options** to configure the plugin.
+\\ {{:fftut16.png|}}
 This page will be brought up. This is where we will be configuring the server information or linking the plugin to your seedbox.
+\\ {{:fftut2.png|}}
 Now you have two options. Manual configuration or the Server Wizard.
+===== Manual Configuration =====
+Select **Add server** from the top right of the "Xirvik seedbox options page".
+\\ Bringing up the "Server Info" dialog box.
+\\ Enter this information as recieved in your service activation email.
-Manual Configuration
+Don't forget the https: at the start of the host URL!!!
+\\ {{:fftut3.png|}}
-Select Add server from the top right of the "Xirvik seedbox options page". Bringing up the "Server Info" dialog box.
-Enter this information as recieved in your service activation email.
-Don't forget the https:// at the start of the host URL!!!
 Leave "Port" at the default of 80.
@@ Line 48: / Line 46: @@
 Don't forget to select Save to commit the changes and create the link to your seedbox.
+\\ {{:fftut4.png|}}
+\\ That's all for the manual configuration!
-That's all for the manual configuration!
-Server Wizard
-Select server wizard from the bottom of the seedbox info configuration page.
+===== Server Wizard =====
-This will open an easy and intuitive wizard that will guide you through setting up your plugin.
-The first step is to select what type of subscription you chose. The options are Dedicated, Semi-Dedicated, or Shared.
+\\ {{:fftut22.png|}}
+Select **server wizard** from the bottom of the seedbox info configuration page.
-Hit Next.
+\\ This will open an easy and intuitive wizard that will guide you through setting up your plugin.
-Now enter your access information just as you got it in your Service Activation E-Mail.
+\\ The first step is to select what type of subscription you chose. The options are Dedicated, Semi-Dedicated, or Shared.
-Don't forget the https:// at the start of the host URL!!
+\\ {{:fftut9.png|}}
-If you are lazy you can just copy the whole service activation e-mail, select parse your welcome e-mail and paste it in the dialog box.
+Hit **Next**.
-Then hit Parse. This will extract the necessary information from the e-mail and correctly configure it for you.
-Example:
+Now enter your access information just as you got it in your Service Activation E-Mail.
+\\ Don't forget the https: at the start of the host URL!!
+\\ {{:fftut10.png|}}
-Hit Finish after verifying that the information is correctly input.
+If you are lazy you can just copy the whole service activation e-mail, select parse your welcome e-mail and paste it in the dialog box.
+\\ Then hit Parse. This will extract the necessary information from the e-mail and correctly configure it for you.
+\\ Example:
+\\ {{:fftut11.png|}}
-Don't forget to Save after making any changes to the configuration..
+Hit **Finish** after verifying that the information is correctly input.
+Don't forget to **Save** after making any changes to the configuration..
+\\ {{:fftut4.png|}}
 At this point the plugin should be configured and ready for action!
+===== Advanced Configuration Options =====
-Advanced Configuration Options
 We also offer a few more configuration options for the more advanced user.
 They are available at the bottom of the main plugin optiions window (as seen below).
 Most users can skip to the next section, but if you want further customizability, read ahead.
+\\ {{:fftut14.png|}}
+=== Context menu capture ===
-Context menu capture
+\\ {{:fftut8.png|}}
@@ Line 106: / Line 111: @@
 The final option is to simply turn off the context menu support completely.
-Progress messages
+=== Progress messages ===
 This portion is basic. When do you want to be notified of the plugins actions?
@@ Line 114: / Line 120: @@
 It's not recommended but you can deselect all of the checkmarks.
-rTorrent-specific options
+=== rTorrent-specific options ===
 These settings only apply to rTorrent.
@@ Line 124: / Line 131: @@
 When enabled "Edit directories before uploading" will prompt you to change the download location on your seedbox hard drive.
-Server Timeout
+=== Server Timeout ===
 This option specifies the number (in seconds) that the server has to respond before the connection is cancelled.
@@ Line 131: / Line 139: @@
 Don't forget to Save after making any changes to the configuration..
+\\ {{:fftut4.png|}}
+===== Testing & Demonstration =====
-Testing & Demonstration
 Now let's test it to make sure everything was input correctly and works!
 First step is to try an "artificial" test, or a test that doesn't involve torrents.
-To do this return to the the seedbox configuration page, highlight the seedbox we just entered and select Test server.
+To do this return to the the seedbox configuration page, highlight the seedbox we just entered and select **Test server**.
+\\ {{:fftut5.png|}}
 This is the result we're looking for.
+\\ {{:fftut6.png|}}
 Now for an actual test/demonstration to verify that it's working.
-First let's hit Save to make sure our configuration is saved.
+First let's hit **Save** to make sure our configuration is saved.
+\\ {{:fftut4.png|}}
 Go to your favorite torrent tracker, and right click on the download link of a torrent as seen below.
+\\ {{:fftut7.png|}}
-Select Upload to yourserver.xirvik.com.
+Select **Upload to yourserver.xirvik.com**.
 Remember: You may add as many servers as you'd like and then select which seedbox to upload the torrent to from the context menu (as seen below).
+\\ {{:fftut8.png|}}
 Another upload method is to click on a torrent download link.
-Then select the option Upload to Xirvik and choose your server from the dropdown menu.
+Then select the option **Upload to Xirvik** and choose your server from the dropdown menu.
+\\ {{:fftut13.png|}}
-Hit OK to send over the torrent!
+Hit **OK** to send over the torrent!
 You know that the upload was successful if you recieve this message.
+\\ {{:fftut12.png|}}