ShopSite Auth File Information

A ShopSite auth file is the digital equivalent to the keys of your store; it is used to open your store, and to help protect your store and the information your customers entrust you with. You can not install or run ShopSite without a valid auth file, which can only be used with your store.

When you obtain a ShopSite store license from a ShopSite reseller, such as your hosting provider, a unique auth file is generated. The auth file contains information specific to your store, such as your storeid (the username you use to log in to your ShopSite back office), a unique serial number, the store URL, and the service level for your store. This information is stored in an encrypted format in your auth file for your security.

Be sure to use ASCII (text file) format any time you use FTP to transfer your Auth file.

In order to install or upgrade ShopSite, you must put the auth file in a location where the install programs can find it. On Linux and UNIX servers, the auth file must be in the install directory, with the name store.auth. Windows-based installations will prompt you for the auth file during the installation process.

Once ShopSite has been installed, your auth file is stored in your store's data directory.1 with the name storeid.auth (where storeid is the username you use to log in to the ShopSite back office).

Replacing an Auth File

There are several possible situations where you would be required to replace your store's auth file with a new one. Your auth file contains various information used to uniquely identify your store, so you will require a new auth file any time that information changes. This includes changes to your store URL or the service level of your store. You should not change the storeid of an existing store.2 You may also need to obtain a new auth file if you are moving your store to a server running a different operating system.

Your ShopSite reseller can provide you with a new auth file if you need to replace it. When you request a new auth file, your ShopSite reseller will need the following information (see the Store Settings and Product Information sections of your Preferences > Hosting Service screen for this information):

After you have obtained a new auth file, you can install it by doing the following:

  1. Backup your current auth file. If something is wrong with your new auth file, you may need to restore the old one until you can get your new auth file replaced. Your auth file is located in your store's data directory1, and is named storeid.auth (where storeid is the username you use to sign in to your ShopSite back office). You can make a copy of the file with a different name (storeid.auth.old, for example) in the same directory, or on your local PC. Be sure to use ASCII (text file) format any time you use FTP to transfer your Auth file.
  2. Save the new auth file as storeid.auth (where storeid is the username you use to sign in to your ShopSite back office) in your store's data directory1. Make sure the file name matches the storeid of your store, or ShopSite will not run.
  3. Log in to your ShopSite back office and check that the new auth file is installed correctly. The store version and service level are indicated at the bottom of the main back office screen, followed by your storeid. If you have any problems, see the troubleshooting section below.

Troubleshooting Auth File Problems

If you are having trouble installing or upgrading ShopSite, or if you are unable to access ShopSite after installing or upgrading ShopSite, your auth file could be part of what is causing your problems. The following are a few things to be aware of with regard to your auth file:

  1. Did you use ASCII format to transfer your Auth file? - Any time you use FTP to transfer your Auth file, you should use the ASCII (text file) format. If you transferred the file using BIN format, the end-of-line characters in the file may not match the ones used by your operating system, causing the file to appear corrupted to the Web server. Always use ASCII format to transfer your auth file via FTP.
  2. Is your Auth file in the correct location? - If you are installing or upgrading ShopSite on a Linux or UNIX server, you must place a copy of your auth file in the install directory, and name the file store.auth. Once the store is running, the auth file must be located in the data directory with the name storeid.auth (where storeid is the username you use to log in to the ShopSite back office).
  3. Can your Web server read your auth file? - Your Web server must have permission to read the auth file in order to run or install ShopSite. See Linux/UNIX Permissions or Windows Permissions for more information.
  4. Does your auth file match your settings? - Your auth file includes the storeid, store URL, and other information specific to your store. If you have changed any of these settings, you will need to get a new auth file with the new information in it. Contact your ShopSite reseller for more information.

Footnotes:

1. The data directory is where the information unique to your store is kept. For more information see Data directory for Linux/UNIX Installs or Data Directory for Windows Installs help for more information.

2. The storeid and serial number are used as part of a system that associates shopping cart and order information with only your store and encrypts the information so it can not be viewed by anyone else. If you were to change your storeid or serial number, you would no longer be able to view or process orders placed prior to the change.