Difference between revisions of "Freeside:Documentation:FAQ"

Revision as of 04:20, 11 July 2006

FreeSide FAQ

Q. What is Freeside's license?

Freeside is licensed under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; either version 2, or (at your option) any later version.

Q. Using DBD::Pg 1.40, I receive an Use of uninitialized value in die or syntax error at or near "$1" error when running freeside-setup or after upgrading DBD::Pg

DBD::Pg 1.40 has a grave bug (http://rt.cpan.org/NoAuth/Bug.html?id=12004) which causes these errors. Please use 1.41 or later (1.32 is also okay).

Q. Running freeside-setup errors out with: Badly formed sub country data

Before running freeside-setup, run:

   export LANG=C (sh, bash, zsh, etc. shells)
   setenv LANG C (csh or tcsh shell)

Q. Using Apache::ASP, the information entered in forms is getting lost. What is wrong?

try adding: PerlSetVar RequestBinaryRead Off to your apache config file.

Q. Is mod_perl version 2 (1.99) (and its associated Apache 2.x) supported by Freeside?

No. See e.g. http://www.sisd.com/freeside/list-archive/msg03312.html and http://www.sisd.com/freeside/list-archive/msg03360.html for messages from Ivan on the topic.

If you install Freeside on a system running a pre-release mod_perl version 2 (1.99), you might be able to make it mostly work. However, installations of Freeside under mod_perl version 2 (1.99) have been observed to give buggy behavior in certain instances, specifically in using the Web interface to set up configuration. Your best bet is to stay with Apache 1 and mod_perl 1 until a. version 2 of mod_perl is officially released, and b. Freeside support has been announced.

Q. I'm running Red Hat 9 and it comes with Apache 2 / mod_perl 1.99 installed already! How do I downgrade? </b>

These days, ApacheToolbox is probably your best bet. Pointers to a well-maintained source of Apache 1 RPMs for RH9 (or any Fedora versions too, in fact) would be appreciated.

Q. What databases are supported by Freeside?

PostgreSQL 7.x/8.x is supported.

MySQL is not currently supported. Developers interested in maintaining the :MySQL port are welcome to ask on the -devel mailing list.

Note: the above only applies to the database used by the Freeside software itself. Freeside can integrate with RADIUS servers running MySQL (any version) or any other database.

Q. I'm trying to run Freeside on a VirtualHost, and I get "not running uid freeside" errors.

Your mod_perl-enabled Apache instance must run as user "freeside." This means that the entire server instance must be running as user "freeside," which is accomplished through a server-level User freeside directive. You cannot just put User freeside within a VirtualHost block (try running ps -auxwww and you'll see that the apache processes are owned by the server-level specified user, not the virtual host-level specified user).

Since "scripts" run under mod_perl are run in-process by the embedded perl interpreter and are not executed in a separate process as CGI scripts, you cannot use suEXEC to obtain a different username in VirtualHost context.

The recommended configuration is to run a separate, mod_perl-enabled Apache instance on a private, firewalled backend server, not on a public webserver.

Q. Isn't it insecure to use rsync?

Sometimes. But in the case of freeside, it uses rsync over ssh, so this is not a problem here.

Q. What's the purpose of the Session Server?

It records sessions (ie. login + logout, etc), so that the database can tell who is logged on at any given time. These days, most folks use a RADIUS server such as FreeRADIUS which includes an SQL session database instead of using the Freeside session server.

Q. What's the purpose of the Self-Service Server and how does it work?

The Self-Service server is run on a separate, public box. The Freeside server connects to it via SSH. When a user comes to the Self-Service Server, he logs in and his username and password are authenticated against a Service (svc_acct) in a Package that is active for his Freeside customer record. The Self-Service Server then gets a session ID which it uses in communicating with the Freeside server for purposes of working on this user's customer record.

It is intended to provide, out of the box, a way to have users sign up for a package and cancel that package. Recent additions have begun to make it possible also to add packages to an existing user and list those packages that user has purchased. The Self-Service Server system comes with some ready-made CGIs that handle the most basic of these tasks for you. The main thing to realize about it is that the customer must have a Package with a Service of type account set up with a username and password so that he may log in.

Q. How do I set a minimum UID/GID?

Edit /usr/local/etc/freeside/counters.[datasource]/svc_acct.uid . This is Freeside-wide, not specific to any export driver.

Q. After installing mod_perl, my Apache logs say: [error] Can't locate Apache.pm in @INC (...)

Install Apache::Request

Q. After installing mod_perl, my Apache logs say: "Can't locate mod_perl.pm in @INC" (...)

Include the path to mod_perl.pm by editing apachectl and specifying it.

An example is below (adjust to your needs):

-- near the top of apachectl --
PERL5LIB=$PERL5LIB:/more/paths/to/search:/directory/of/mod_perl:/even/more/places
export PERL5LIB
-- end of apachectl modifications --

Q. When building software prererquisites for Freeside, which combinations are known to break/fail?</b>

Any: DBD::Pg 1.32 with DBI 1.42 fails "make test". DBI 1.41 is ok. Update: Test failures are harmless, DBI::Pg 1.32 works fine with DBI 1.42.

FreeBSD ports sometimes has trouble with perl and modules:

1. IPC::ShareLite (used in selfservice for 1.5.x) may coredump. Reported on FreeBSD 4 and 5 with various perl versions. Update: as of 1.5.7, "selfservice_server-session_module" configuration value can be set to "Cache::FileCache" instead and IPC::ShareLite will not be necessary.
2. Storable may be broken due to the new "-D64bitint" flag that is compiled into perl. Reported on FreeBSD 4.10 and perl 5.8.4.

Q. freeside-daily emits warnings like

     WARNING:  Skipping "pg_group" --- only table or database owner can VACUUM it

Should I be concerned?

No. These messages are harmless.

Q. "Host Key Verification Failed" errors, how do I resolve these?

This error occurs when freeside tries an unattended login via ssh. The .ssh/known_hosts file on the freeside host must contain entries for the target host(s). You must ssh into the target host as users root and freeside using the IP or hostname/fqdn specified in the export and/or server commands (passwd, sign-up, self-service). You cannot have an IP based entry in the known_hosts file and then use a hostname for the exports etc., the verification will fail. Or you can change the sshd_config file directive IgnoreUserKnownHosts from no to yes. But caution, this will expose your system to security threats if your keys are compromised.

Q. Using Cisco NAS devices, RADIUS session history does not show IP addresses, and search by IP address does not work. What's wrong?

Use the "aaa accounting delay-start" command on Cisco NAS devices to instruct them to report IP addresses to RADIUS.

Q. How do I enable a second address (service/shipping address) in an existing database?</b>

Apply the following changes to your database:

     ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
     ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
     CREATE INDEX cust_main4s ON cust_main ( ship_last );
     CREATE INDEX cust_main5s ON cust_main ( ship_company );
     ALTER TABLE h_cust_main ADD COLUMN ship_last varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_first varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_company varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_address1 varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_address2 varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_city varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_county varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_state varchar(80) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_zip varchar(10) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_country char(2) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_daytime varchar(20) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_night varchar(20) NULL;
     ALTER TABLE h_cust_main ADD COLUMN ship_fax varchar(12) NULL;
     CREATE INDEX h_cust_main4s ON h_cust_main ( ship_last );
     CREATE INDEX h_cust_main5s ON h_cust_main ( ship_company );

And run bin/dbdef-create username.

Q. How do I setup prepaid packages?

Minimum verison 1.5.8 is required.

To create a package with one hour of usage, set "seconds" in the service definition to "default" and "3600", OR, use prepaid cards with the desired duration. You also need to a usage-capable export setup (currently sqlradius, sqlradius_withdomain or radiator), and you need to make sure "freeside-sqlradius-radacctd" is running (uncomment the section that starts it in your init script).

To create a pacakge with one week of availability, set the package definition to the "Prepaid, flat rate" price plan, and set the Recurring fee frequence to "weekly".

These can be used separately or together.

Q. I cannot add a user account. I see Error: Can't find svc_acct.domsvc in svc_domain.svcnum. What do I do?

Follow the directions in docs/admin.html exactly. You have failed to "Add your own domain." Create a package containing a svc_domain service. Sell it to yourself. Provision it with your domain.