Installation

This document explains how to install and uninstall Google Sitemap Generator.

In this document:

  1. Windows Installation
    1. Prerequisites
    2. Installation steps
    3. Results of the installation
    4. Uninstallation steps
  2. Linux Installation
    1. Prerequisites
    2. Installation steps
    3. Results of the installation
    4. Uninstallation steps

Windows Installation

This section provides installation instructions for Windows platforms.


Prerequisites

These are the prerequisites for installation:


Installation Process

Installation of Google Sitemap Generator restarts the World Wide Web Publishing service. Be sure to perform the installation at a time when the restart won't cause a problem.

Follow these steps to install Google Sitemap Generator:

  1. From http://code.google.com/p/googlesitemapgenerator/downloads/list , download the latest version of the msi file.
  2. Run the file to launch the setup program.

    Note: If you've previously installed Google Sitemap Generator, or if you've started the installation and not completed it, the installer asks whether you want to repair the software or remove it. Select Remove Google Sitemap Generator (Beta) and then click Finish to start the uninstallation program. When uninstallation is complete, you can restart the installation.

  3. When the License Agreement appears, read and accept the Terms of Service. If you do not accept the Terms of Service, click Cancel to exit the installation.

    The Privacy Warning now appears.

  4. Read the Privacy Warning, which contains important information. Click Next to continue.

    The Automatic Sitemap submission panel now asks whether you want Google Sitemap Generator to start up with automatic submission of Web Sitemaps enabled. When the software starts running, automatic submission is disabled by default.

    • To defer submission of submitting Sitemaps, you can accept the default value. In the Admin Console, you'll be able to configure and test Sitemaps before submitting them.
    • To start automatic submission now, you can choose First installation. Start with automatic submission enabled.
    • If you are reinstalling, you have an additional option, Use the old automatic submission settings. This option reinstates the settings that were in effect when you uninstalled and enables you to retain per-site configurations.

    If you accidentally choose one of the first two options during a reinstall, the specified configuration applies, but your old configuration file will be lost. If you accidentally choose the last option during your first install, the default value of starting with automatic submission disabled applies.

  5. Make your choice and then click Next.

    Because IIS must restart before Google Sitemap Generator takes effect, you're now asked about the IIS restart.

  6. Specify whether you want to let the installation program restart IIS automatically after installation is complete, or to restart IIS manually.

    The Select Installation Folder page appears, showing a default folder and letting you choose a different folder.

  7. When you're done, click Next.
  8. When the Confirm Installation page asks you to confirm the installation, click Next to install.

    A progress bar appears while Google Sitemap Generator installs its Windows service and IIS filter and then restarts the World Wide Web Publishing service. Several windows may open and close during this time.

  9. When a command window opens and waits for you to "Enter new password," provide a password for the Admin Console.

    Command windows now display the startup of various components. When all startup is complete, a browser opens, to the address http://your-address:8181. The Installation Complete page of the installer program might be behind your browser.

  10. On the Installation Complete page, click Close to exit.

Now you're ready to configure Google Sitemap Generator, which has already detected your websites. View the configuration document for more information about how to configure the settings for your websites.


Results of the Installation

Installation of Google Sitemap Generator has the following effects on your system:


Uninstallation Steps

  1. From the Windows Control Panel's Add or Remove Programs window, find Google Sitemap Generator and click Remove.

    Google Sitemap Generator is then ready to uninstall its Windows service and IIS filter, and to restart the World Wide Web Publishing service.

  2. When you are prompted "Are you sure you want to remove Google Sitemap Generator...," click Yes. A progress bar appears to display the progress of the uninstallation.
  3. When the "Installation Complete" message appears, click Close to remove the message. If you plan to reinstall Google Sitemap Generator in the future, you're done!
  4. If you don't plan to reinstall Google Sitemap Generator in the future, you can manually remove the historical data and the configuration file. These files are in website-specific directories under C:\Program Files\Google\Google Sitemap Generator, unless you specified an alternative path during installation.

Back to top

Linux Installation

This section provides installation instructions for Linux platforms.


Prerequisites

These are the prerequisites for installation:


Installation Process

Follow these steps to install Google Sitemap Generator:

  1. From http://code.google.com/p/googlesitemapgenerator/downloads/list, download the installation package that matches your Linux version and Apache version.
  2. Using the root account, extract the install package:

    tar –zxvf filename

    In this format, filename is the name of the version-specific installation package you downloaded.

  3. Run the install script, using the following command format:

    sitemap-install/install.sh [option]...

    In this format, option is one of the following:

    • -h displays help about these command line options.
    • -d directory specifies a non-default installation directory.
    • -a Apache-binary-filename specifies the path to the Apache binary file (httpd). Alternatively, you can specify this value during installation.
    • -c Apache-config-filename specifies the Apache root configuration file.
    • -g Apache-group specifies the user group name under which Apache is running.
    • -t Apache-control-filename specifies the Apache control script (apache ctl). If you specify this value, the installer lets you choose to automatically restart Apache at the end of the installation. If you omit this option, you'll need to restart Apache manually.

    All of these parameters are optional. Use a space to separate multiple options.

    Example: sitemap-install/install.sh -t /usr/sbin/apache2ctl -g www-data

    The script responds in one of the following ways:

    • Continues with the installation.
    • Informs you that a previous version exists, and asks whether you want to uninstall. If you answer Y (yes), the installation script stops and runs the uninstallation script. When uninstallation completes, you can restart the installation.
    • Informs you that files remain from a previous installation, and asks whether you want to overwrite them. This message appears even if you previously started an installation that did not complete. Overwriting these files does not harm any database files or configuration files that were previously created and saved at uninstallation.

    The installation now starts and displays the privacy policy.

    ********************************************************************* 
    Welcome to Google Sitemap Generator (Beta) 
    For more information, please visit: 
    http://code.google.com/p/googlesitemapgenerator/ 
    ******************************************************************** 
    Any Sitemap information that you send to Google, including Sitemaps... 
  4. Read the privacy warning, which contains important information.
  5. Press Enter to continue. The Terms of Service appear. Note their location, in case you need to read them again.
  6. Read the Terms of Service.
    Do you agree with the Terms of Service? [N/y]y 
  7. Enter y (yes) if you agree with these terms. If you press Enter to take the default response or answer N (no), the installation script exits.

    The installer now displays the default installation directory, or the non-default value that you specified on the installation command line.

    Google Sitemap Generator will be installed into /usr/local/google-sitemap-generator
  8. If the directory is not empty, the install script asks whether you want to overwrite the old files in the directory. If you agree to overwrite the files, you don't lose the old configuration file and database that you'd previously saved during the previous uninstallation.

    If you did not use the -a or -t option to start the installation script, it now asks for the location of the Apache binary file (httpd) or control script (apache ctl), so that it can find the configuration file and get information about your Apache installation.

    This installation updates the Apache configuration file. To find that file, 
    the installer needs the location of the Apache binary (httpd) or control 
    script (apachectl). The binary or control script that you specify must 
    support the -V option.  
    
    
    What is the location of the Apache binary or control script? [/usr/sbin/apache2]  
  9. If this message appears, accept the displayed value or specify a different binary or control script.

    The installation script now displays information about your Apache configuration and asks whether it is correct.

     *********************************************************************
          The following information about your Apache installation has been detected:
          * Apache version: 2.0
          * Apache architecture: 32 bits
          * Apache root configuration file: /etc/apache2/apache2.conf
          * Apache pid file: /var/run/apache2.pid
          * Apache group: www
    *********************************************************************
    Is all of this information correct?
    If you answer No, installation will terminate and you'll need to restart the 
    installation, using the necessary command-line options. [N/y] 
  10. Examine the information carefully, and then do one of the following:
    • Answer y (Yes) if the script found the correct binary or control script, and if all the other information is correct.
    • Accept the default response or answer N (No) if the binary or control script is incorrect and you want to correct it. If you see any questionable information, such as an environment variable instead of a value, answer no (N) to cancel the installation. When you restart the installation, provide the necessary information on the command line.

      If everything is fine, some lines like this appear.

      Google Sitemap Generator will start creating Web Sitemap files as soon as it
      starts up. Do you want Google Sitemap Generator to start submitting these
      files automatically? There are three options:
      
      1.  First installation. Start with automatic submission disabled.
      2.  First installation. Start with automatic submission enabled.
      3.  Reinstallation. Use the old automatic submission settings.
      
      Specify your choice [1]:2

    If you are installing Google Sitemap Generator for the first time, you can start it with automatic submission disabled or enabled. By default, it starts with automatic submission disabled, providing time for configuration and testing before Sitemap files are submitted to search engines. This setting applies to all websites on the web server.

    If you are reinstalling Google Sitemap Generator:

    • You can reuse the site-specific automatic submission settings that were in effect when you uninstalled. If only some sites were configured for automatic Web Sitemap submission, only those sites are enabled at startup. Automatic Web Sitemap submission is specified under Sitemap file submission and controlled by the robots.txt option and the search engine ping URLs.
    • You can start all sites on the web server with automatic submission disabled (option 1) or enabled (option 2). However, those options also set all your other configuration settings to their default values.
  11. Specify the option for automatic Web Sitemap submission.

    You'll now see status messages showing progress.

    Program files successfully copied.
    Google Sitemap Generator settings successfully updated.
    Google Sitemap Generator init scripts successfully installed.
    Apache configuration successfully updated.
    Old configuration is saved at /etc/google-sitemap-generator/httpd.install.conf
    Ready to set the password for the administration console.
    Enter new password (5 or more characters):
  12. Enter a password and then confirm the password.
    Google Sitemap Generator daemon successfully started.

    If you specified the -t option on the command line, the script now asks whether you want to restart Apache.

    To start the Google Sitemap Generator module in Apache, you must restart Apache. 
    Do you want to restart Apache now? [N/y]
  13. Accept the default response, N (No) to defer the Apache restart, or answer y (Yes) to restart Apache now.

    If you answer N, the following message appears:

    Google Sitemap Generator (Beta) is installed successfully. 
    After you restart Apache, you can go to http://<this-server-address>:8181/ to configure the application.

    If you answer Y, the following message appears:

    Google Sitemap Generator (Beta) was successfully installed. 
    Apache was successfully restarted.
    You can now go to http://<this-server-address>:8181/ to start configuration.

You're now done and ready to configure Google Sitemap Generator. View the configuration document for more information about how to configure the settings for your websites.


Results of the Installation

This section describes the changes that the installation makes to your system. The section covers:


Files installed

Installation of Google Sitemap Generator creates the files listed in the following table.

File Description
/usr/local/google-sitemap-generator Path to the program files, settings, and so on
/etc/google-sitemap-generator Global registry information about Google Sitemap Generator
/etc/init.d Contains scripts for starting Google Sitemap Generator.


Changes to the Apache configuration file

During installation, the installation script first backs up the Apache configuration file and then modifies the configuration file. The installation script does the following:

If you uninstall Google Sitemap Generator, the uninstallation script removes the Include line from the configuration file.


The control script

Once installation is complete, Google Sitemap Generator service automatically starts when the system starts. When the system is running, you can control the Google Sitemap Generator service by running this script, for which you'll need root privileges:

/usr/sbin/google-sitemap-generator-ctl

You must have root privileges in order to run the script.

Use the following command to control the Google Sitemap Generator service:

sudo google-sitemap-generator-ctl service start | stop | restart

Note that this script controls the Google Sitemap Generator service, but it does not control the Sitemap filter in Apache. To control the filter, you'll need to use the Apache controller.


Uninstallation Steps

Before starting, note that the Apache server must be stopped in order for uninstallation to occur. If the Apache server is running, you will be asked to stop it.

To uninstall Google Sitemap Generator, use the root account to run the uninstall script, as follows:

/usr/local/google-sitemap-generator/uninstall.sh

The last lines of the uninstallation script are as follows:

The URL database and application settings file can be saved and used when 
you reinstall. If you choose to save the files now, but later you want to 
remove them, you can run this script again."
"Do you want to save the URL database and application settings file ? [Y/n]"

Respond as follows:

Back to to

Updated on