Difference between revisions of "New Installation Instructions"

From MircWiki
Jump to: navigation, search
(Step 3: Install Tomcat)
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This document will walk you through the installation of a brand new MIRC Site.
+
This document will walk you through the installation of a new MIRC Site on a Microsoft Windows XP machine. Special instructions are available for [[MIRC Installation on Vista|Vista]]. Instructions are also available for [[MIRC Installation on Macintosh|Mac OS X]], [[Installing MIRC on a Linux Server|Linux]], provided by MIRC users.
  
 
==Step 1: Install Java==
 
==Step 1: Install Java==
  
To run MIRC, you must have Java version 1.5 or newer installed. You may also see this referred to as Java Runtime Environment 5.0, both are equivalent. The easiest way to install Java is simply to point your web browser at http://www.java.com and follow the download links to install the latest version of Java on your system. You only need the Java Runtime Environment (JRE), not the Java Developer's Kit (JDK), although either one will work.
+
To run MIRC, you must have Java version 1.5 or newer installed. The latest Java is currently 1.6. For new installations, it is preferred. The easiest way to obtain Java is simply to point your web browser at http://www.java.com and follow the download links to install the latest version of Java on your system. For normal installations, you only need the Java Runtime Environment (JRE), not the Java Developer's Kit (JDK), although either one will work.
  
==Step 2: Install Java Advanced Imaging(JAI)==
+
==Step 2: Install the Java Advanced Imaging ImageIO Tools==
  
 
MIRC uses Java's advanced imaging features. These must be installed separately after Java has been installed.   
 
MIRC uses Java's advanced imaging features. These must be installed separately after Java has been installed.   
  
* First, with your web browser, go to http://java.sun.com/products/java-media/jai/current.html.  Scroll down to the bold heading '''Java Advanced Imaging-Image I/O Tools Downloads'''. Be careful to find that heading and not the one above it, which is '''Java Advanced Imaging Downloads'''.  Once you have found the correct heading, click the newest release that is not an alpha or beta release (at the time of authoring, that's version 1.1).
+
* First, with your web browser, go to http://java.sun.com/products/java-media/jai/current.html.  Scroll down to the bold heading '''Java Advanced Imaging-Image I/O Tools Downloads'''. Be careful to find that heading and not the one above it, which is '''Java Advanced Imaging Downloads'''.  Click the newest release that is not an alpha or beta release (currently version 1.1).
  
* Next you must select the appropriate download for your operating system.  Find your operating system in the list, and click the link that contains the letters "jre" near the end.  This assumes that you are running the JRE version of java, if you happen to be running the JDK version, download that file instead.  Typically only Java developers are running the JDK version of java.
+
* Next you must select the appropriate download for your operating system.  Find your operating system in the list, and click the link that contains the letters "jre" near the end.  This assumes that you are running the JRE version of java, if you happen to be running the JDK version, download that file instead.  Typically only Java developers need the JDK version of java.
  
 
* Now run the installation file you just downloaded.  This installation is straightforward, just agree to the license agreement, do a "Complete" install, and click "Next" the whole way through.
 
* Now run the installation file you just downloaded.  This installation is straightforward, just agree to the license agreement, do a "Complete" install, and click "Next" the whole way through.
  
==Step 3: Install Tomcat 5.5==
+
==Step 3: Install Tomcat==
 
+
Note: Vista and Windows 7 users should see [[MIRC Installation on Vista]] for more specific instructions about how to install Tomcat on these operating systems.
  
 
===Download Tomcat===
 
===Download Tomcat===
  
* Next, you must download Apache Tomcat.  With your web browser, go to http://tomcat.apache.org/.  On the left hand side of the page you should see a "Downloads" section.  Within this section you will see various versions of Tomcat, you're looking for version 5.5, so click on the Tomcat 5.5 link.
+
* Next, you must download Apache Tomcat.  With your web browser, go to http://tomcat.apache.org/.  On the left hand side of the page you should see a "Downloads" section.  Within this section you will see various versions of Tomcat. MIRC runs on Tomcat 5.5 and Tomcat 6.0. For new installations, 6.0 is recommended.
  
* On the next page, if you scroll down you'll see different versions that are available for download.  Select the newest version of Tomcat listed that isn't an alpha or beta (at the time of authoring, the newest version is 5.5.20).  If you're on a Windows machine, select the "Windows Service Installer" downloads option. Otherwise, download the zip file.
+
* On the next page, if you scroll down you'll see different versions that are available for download.  Select the newest version of Tomcat listed that isn't an alpha or beta (at the time of authoring, the newest version is 6.0.18).  If you're on a Windows or Vista machine, select the "Windows Service Installer" downloads option. (For Linux and Mac, download the zip file.)
  
 
===Windows Installation Instructions===
 
===Windows Installation Instructions===
Line 48: Line 48:
 
===Download MIRC===
 
===Download MIRC===
  
* You are now ready to install MIRC, but first you must get the installer. You can download the latest version of MIRC from the [[Downloads]] page.  It's recommended that you grab the latest non-beta release, and you'll want the "Full Installer" version.
+
* You are now ready to install MIRC. Download the latest version of the MIRC installer from the [[Downloads]] page.  If multiple versions are available on that page, select the "Full Installer" version.
  
'''''Tip:'' Save the installer file on the same drive where Tomcat is installed. The installer only knows how to search on the drive where it is located. If you put it somewhere else, it will not find Tomcat and make you find it by hand.'''
+
:'''''Tip:'' Save the installer file on the same drive where Tomcat is installed. The installer only knows how to search on the drive where it is located. If you put it somewhere else, it will not find Tomcat and make you find it by hand.'''
  
 
===Install MIRC===
 
===Install MIRC===
Line 56: Line 56:
 
====Locate Tomcat====
 
====Locate Tomcat====
  
* Now, run the installer by double-clicking it.
+
* Make sure that Tomcat is stopped.  XP and Vista users should use the Windows Services applet to stop it, although XP users can use the Apache Tomcat Properties application as well.
 
+
* Now, run the installer by double-clicking it. A welcome page will appear. click '''Next'''.
* Make <b>absolutely</b> sure that you have stopped TomcatIf Tomcat is running, see [[Using the Tomcat Properties application]] for help on stopping it. Then click '''Next'''.  
+
* The installer will look for an existing installation of Tomcat. If your installer did not find Tomcat you will have to click browse, and find your Tomcat directory manually. When ready click '''Next'''.
 
+
* The installer will look for an existing installation of Tomcat. If your installer did not find Tomcat you will have to click browse, and find your Tomcat directory manually. When ready click '''Next'''.  
+
  
 
====Install Query Service====
 
====Install Query Service====
Line 68: Line 66:
 
* You will see a dialog asking you to provide a name for your MIRC site. After typing in the name of your MIRC Site click '''OK'''.
 
* You will see a dialog asking you to provide a name for your MIRC site. After typing in the name of your MIRC Site click '''OK'''.
  
* Now the installer will ask you whether you want MIRC to determine its network address automatically. If you have multiple network cards, you should click No and supply the IP address that you want MIRC to use when the installer asks.  Otherwise click '''Yes'''.
+
* Now the installer will ask you whether you want MIRC to determine its network address automatically. If you have multiple network cards, you should click '''No''' and supply the IP address that you want MIRC to use.  Otherwise click '''Yes'''.
  
 
====Install Storage Service(s)====
 
====Install Storage Service(s)====
Line 74: Line 72:
 
* Next, it will then ask if you want to install a storage service.  Click '''Install'''.
 
* Next, it will then ask if you want to install a storage service.  Click '''Install'''.
  
* The program will then ask you for a one-word name for the storage service. Generally, a short, lower-case word is best, but you can make it whatever you like.  If you're unsure what to use, just type the word "storage".  After choosing a name, click '''OK'''.
+
* The program will then ask you for a one-word name for the storage service. Generally, a short, lower-case word is best, but you can make it whatever you like.  If you're unsure what to use, just type the word '''storage'''.  After choosing a name, click '''OK'''.
  
 
* The installer will then ask you for a storage service name that will be shown to users. Choose a descriptive name, especially on sites which will host multiple storage services, so the user will have some idea of what is on the site. Enter the storage service name and click '''OK'''.
 
* The installer will then ask you for a storage service name that will be shown to users. Choose a descriptive name, especially on sites which will host multiple storage services, so the user will have some idea of what is on the site. Enter the storage service name and click '''OK'''.
  
* The installer will then ask you for a short designator prefix for the roles that apply to this service. This prefix allows you to manage groups of storage services conveniently, controlling which groups of users and authors can access or author documents on which groups of services. T he instructions in the window explainthe various options, but most people will just click '''OK'''.
+
* The installer will then ask you for a short designator prefix for the roles that apply to this service. This prefix allows you to manage groups of storage services conveniently, controlling which groups of users and authors can access or author documents on which groups of services. The instructions in the window explain the various options, but for most people the best choice is to just click '''OK''' and accept the default supplied by the installer.
  
 
* Next, the installer will ask for a short description that will be included in query results from this storage service. You can leave it blank or you can enter some descriptive text. Then click '''OK'''.
 
* Next, the installer will ask for a short description that will be included in query results from this storage service. You can leave it blank or you can enter some descriptive text. Then click '''OK'''.
Line 88: Line 86:
 
====Install Test Storage Service====
 
====Install Test Storage Service====
  
* The installer will then ask if you want to install a test storage service. This is only useful for Developers, just click '''Next'''.
+
* The installer will then ask if you want to install a test storage service. This is only useful for MIRC software developers, so you should just click '''Next'''.
  
 
====Setup Admin User====
 
====Setup Admin User====
Line 94: Line 92:
 
* Click the '''Create button'''.  
 
* Click the '''Create button'''.  
  
* Type the name of your admin's user name (This can be the same as the admin user you entered during Tomcat installation if you like).  Then click '''OK'''.
+
* Type the username of your admin account (This can be the same as the admin user you entered during Tomcat installation if you like).  Then click '''OK'''.
  
* If it's a new user, you may be prompted to give that user a password.  If that's the case, type in your password once, and hit '''OK''', then confirm the password and click '''OK''' again.
+
* If you have chosen a new username, you may be prompted to enter a password for the new accountEnter the password once, click '''OK''', and then confirm the password and click '''OK''' again.
  
 
* Click Next.
 
* Click Next.
Line 126: Line 124:
 
* Click '''Finished''' to complete the installation.
 
* Click '''Finished''' to complete the installation.
  
==Step5: Wrapping up==
+
==Step 5: Wrapping up==
  
With MIRC installed, you can now start Tomcat Again, for help on this you can see the [[Using the Tomcat Properties application]] document.
+
With MIRC installed, you can now start Tomcat again, for help on this you can see [[Using the Tomcat Properties application]].
  
 
To check that your MIRC site is running, run your browser and go to your site’s URL. If you installed Tomcat on port 8080, click this link: http://127.0.0.1:8080/mirc/query to access your site.
 
To check that your MIRC site is running, run your browser and go to your site’s URL. If you installed Tomcat on port 8080, click this link: http://127.0.0.1:8080/mirc/query to access your site.
  
If you are new to MIRC, you will want to check out the [[MIRC User's Manual]].  For more advanced features you can check out the [[MIRC Administrator's Manual]].  These links are always available in the left column of the MIRC Wiki under '''manuals'''.
+
If you are new to MIRC, you will want to scan the [[MIRC User's Manual]].  For advanced features see the [[MIRC Administrator's Manual]].  These links are always available in the left column of the MIRC Wiki under '''manuals'''.

Latest revision as of 19:02, 10 February 2010

This document will walk you through the installation of a new MIRC Site on a Microsoft Windows XP machine. Special instructions are available for Vista. Instructions are also available for Mac OS X, Linux, provided by MIRC users.

1 Step 1: Install Java

To run MIRC, you must have Java version 1.5 or newer installed. The latest Java is currently 1.6. For new installations, it is preferred. The easiest way to obtain Java is simply to point your web browser at http://www.java.com and follow the download links to install the latest version of Java on your system. For normal installations, you only need the Java Runtime Environment (JRE), not the Java Developer's Kit (JDK), although either one will work.

2 Step 2: Install the Java Advanced Imaging ImageIO Tools

MIRC uses Java's advanced imaging features. These must be installed separately after Java has been installed.

  • First, with your web browser, go to http://java.sun.com/products/java-media/jai/current.html. Scroll down to the bold heading Java Advanced Imaging-Image I/O Tools Downloads. Be careful to find that heading and not the one above it, which is Java Advanced Imaging Downloads. Click the newest release that is not an alpha or beta release (currently version 1.1).
  • Next you must select the appropriate download for your operating system. Find your operating system in the list, and click the link that contains the letters "jre" near the end. This assumes that you are running the JRE version of java, if you happen to be running the JDK version, download that file instead. Typically only Java developers need the JDK version of java.
  • Now run the installation file you just downloaded. This installation is straightforward, just agree to the license agreement, do a "Complete" install, and click "Next" the whole way through.

3 Step 3: Install Tomcat

Note: Vista and Windows 7 users should see MIRC Installation on Vista for more specific instructions about how to install Tomcat on these operating systems.

3.1 Download Tomcat

  • Next, you must download Apache Tomcat. With your web browser, go to http://tomcat.apache.org/. On the left hand side of the page you should see a "Downloads" section. Within this section you will see various versions of Tomcat. MIRC runs on Tomcat 5.5 and Tomcat 6.0. For new installations, 6.0 is recommended.
  • On the next page, if you scroll down you'll see different versions that are available for download. Select the newest version of Tomcat listed that isn't an alpha or beta (at the time of authoring, the newest version is 6.0.18). If you're on a Windows or Vista machine, select the "Windows Service Installer" downloads option. (For Linux and Mac, download the zip file.)

3.2 Windows Installation Instructions

  • Run the installation program you just downloaded, it will display a welcome screen. Click Next.
  • On the license agreement page, accept the terms.
Error creating thumbnail: Unable to save thumbnail to destination
  • The installer will now display the component selection page. This page is VERY important. First, click the plus sign beside "Tomcat" to expand it into its three subcomponents, Core, Service, and Native. Make sure that Tomcat and all three subcomponents are checked. (Core is not selectable, but it should be already checked.) Next, uncheck the remaining components. Then click Next.
  • The program will now display the install location page. This page is also VERY important. If you have multiple disk drives on your system, or multiple partitions (C, D, E, ...) on your drive, you should install Tomcat on a partition that has lots of space. All the documents and images that you will store on your MIRC site will be stored within the Tomcat folder, so you should put Tomcat where there is as much room as possible. If you wish to change the location of your Tomcat installation, click browse and select the directory you want to put it in. When you're happy with the installation directory location click Next.
Error creating thumbnail: Unable to save thumbnail to destination
  • Next, the installer will allow you to select the port on which the server will listen for connections. The default Tomcat port is 8080. If you are running Windows, and if you don’t have any other web servers running on your computer, you could decide to run on the default port for the world wide web, which is 80, but generally it is fine to stay with 8080. This page also allows you to define the administrator's username and password. You should choose something you can remember. Better yet, although I will deny ever suggesting this, write it down. After you make whatever selections you want, click Next.
  • Next, the installer will find the Java JRE. Click Install and the process will proceed to the end. When the final page is displayed, uncheck the two checkboxes and click the Finish button.

Note: If you plan on indexing a lot of images and documents on your site, now is probably a good time to configure your Tomcat memory settings. See the Allocating Additional Memory to Tomcat document for details.

4 Step 4: Install MIRC

4.1 Download MIRC

  • You are now ready to install MIRC. Download the latest version of the MIRC installer from the Downloads page. If multiple versions are available on that page, select the "Full Installer" version.
Tip: Save the installer file on the same drive where Tomcat is installed. The installer only knows how to search on the drive where it is located. If you put it somewhere else, it will not find Tomcat and make you find it by hand.

4.2 Install MIRC

4.2.1 Locate Tomcat

  • Make sure that Tomcat is stopped. XP and Vista users should use the Windows Services applet to stop it, although XP users can use the Apache Tomcat Properties application as well.
  • Now, run the installer by double-clicking it. A welcome page will appear. click Next.
  • The installer will look for an existing installation of Tomcat. If your installer did not find Tomcat you will have to click browse, and find your Tomcat directory manually. When ready click Next.

4.2.2 Install Query Service

  • Click Install to create a query service.
  • You will see a dialog asking you to provide a name for your MIRC site. After typing in the name of your MIRC Site click OK.
  • Now the installer will ask you whether you want MIRC to determine its network address automatically. If you have multiple network cards, you should click No and supply the IP address that you want MIRC to use. Otherwise click Yes.

4.2.3 Install Storage Service(s)

  • Next, it will then ask if you want to install a storage service. Click Install.
  • The program will then ask you for a one-word name for the storage service. Generally, a short, lower-case word is best, but you can make it whatever you like. If you're unsure what to use, just type the word storage. After choosing a name, click OK.
  • The installer will then ask you for a storage service name that will be shown to users. Choose a descriptive name, especially on sites which will host multiple storage services, so the user will have some idea of what is on the site. Enter the storage service name and click OK.
  • The installer will then ask you for a short designator prefix for the roles that apply to this service. This prefix allows you to manage groups of storage services conveniently, controlling which groups of users and authors can access or author documents on which groups of services. The instructions in the window explain the various options, but for most people the best choice is to just click OK and accept the default supplied by the installer.
  • Next, the installer will ask for a short description that will be included in query results from this storage service. You can leave it blank or you can enter some descriptive text. Then click OK.
  • Next, the installer will ask whether you want documents on your site to be indexed automatically or instead to be queued for review before making them publicly available. If you are installing a site for your own use, you should click Yes. If you are installing a site for a department with residents whose work must be reviewed before publication, you may want to think about it. There is no harm in making either choice; the admin service on the site will let you change your mind at any time.
  • The installer will then ask you whether you want to install another storage service. If you want to install more storage services, click Install. Otherwise, click Next.

4.2.4 Install Test Storage Service

  • The installer will then ask if you want to install a test storage service. This is only useful for MIRC software developers, so you should just click Next.

4.2.5 Setup Admin User

  • Click the Create button.
  • Type the username of your admin account (This can be the same as the admin user you entered during Tomcat installation if you like). Then click OK.
  • If you have chosen a new username, you may be prompted to enter a password for the new account. Enter the password once, click OK, and then confirm the password and click OK again.
  • Click Next.

4.2.6 Enabling The Smart Memory Realm

The installer will automatically install and enable the Smart Memory Realm.

  • Click Next.

4.2.7 Enabling the Single Sign-on Authenticator

The installer will automatically enable the Single Sign-on Authenticator.

  • Click Next.

4.2.8 Disabling Tomcat Directory Listings

  • You may or may not wish to have Directory Listing enabled. If you don't want people looking around in your site except through the MIRC query mechanism, you should click Disable.
  • Click Next

4.2.9 Install Query Service Redirector

  • Click Install to enable the Redirector.

4.2.10 Finished

  • Click Finished to complete the installation.

5 Step 5: Wrapping up

With MIRC installed, you can now start Tomcat again, for help on this you can see Using the Tomcat Properties application.

To check that your MIRC site is running, run your browser and go to your site’s URL. If you installed Tomcat on port 8080, click this link: http://127.0.0.1:8080/mirc/query to access your site.

If you are new to MIRC, you will want to scan the MIRC User's Manual. For advanced features see the MIRC Administrator's Manual. These links are always available in the left column of the MIRC Wiki under manuals.