Difference between revisions of "Easy cPanel Install"
(→Edit dbconfig.php file) |
m (Protected "Easy cPanel Install" [edit=sysop:move=sysop]) |
||
(22 intermediate revisions by the same user not shown) | |||
Line 35: | Line 35: | ||
# Refresh the File Manager page. | # Refresh the File Manager page. | ||
# Navigate into the includes directory by clicking the folder icon beside includes: [[Image:CPanel-Includes.png]] | # Navigate into the includes directory by clicking the folder icon beside includes: [[Image:CPanel-Includes.png]] | ||
− | # Click on the filename dbconfig.php: [[Image:CPanel-dbconfigfile.png]] | + | # Scroll down in the listing until you find dbconfig.php. <br/>Click on the filename dbconfig.php: [[Image:CPanel-dbconfigfile.png]] |
# In the top right pane, click Edit File with Code Editor.<br/> [[Image:CPanel-EditFile.png]] | # In the top right pane, click Edit File with Code Editor.<br/> [[Image:CPanel-EditFile.png]] | ||
# This block will open a new box which asks for the character encoding, it is best to leave it at us-ascii:<br/>[[Image:CPanel-CodeEditorAscii.png]] | # This block will open a new box which asks for the character encoding, it is best to leave it at us-ascii:<br/>[[Image:CPanel-CodeEditorAscii.png]] | ||
# Scroll down in this block until you see the '''Edit''' button. Click the '''Edit''' button: [[Image:CPanel-EditButton.png]] | # Scroll down in this block until you see the '''Edit''' button. Click the '''Edit''' button: [[Image:CPanel-EditButton.png]] | ||
− | # Remove the | + | # Find and Remove the ''$needs_edit=1;'' line: <br/>[[Image:CPanel-NeedsEdit.png]] |
− | # Edit these lines with your database information:<br> | + | # Find the Database information lines. This is where you will need the Database Name, Username, and Password as previously noted in the [[#Create_Database|Create Database]] section.<br/>[[Image:CPanel-EditDBInfo.png]] |
− | # Edit this line with your correct path to your files:<br> | + | # Edit these lines with your database information:<br/>[[Image:CPanel-EditedDBInfo.png]]<br/>(Enter your information between the quotes in each line, overwriting the sample data that is there) |
− | # | + | # Find the Workdir information line:<br/>[[Image:CPanel-EditWorkdir.png]] |
− | # Click the Save button to save | + | # Edit this line with your correct path to your files:<br/>[[Image:CPanel-EditedWorkdir.png]]<br>Most cPanel servers paths would be like this:''/home/userdir/public_html'' Substitute <nowiki>'userdir'</nowiki> with your cPanel login username. |
+ | # Find the Cookie Domain information line:<br/>[[Image:CPanel-EditCookieDomain.png]] | ||
+ | # Edit this line with your domain name preceded by a dot:<br/>[[Image:CPanel-EditedCookieDomain.png]] | ||
+ | # Click the '''Save Changes''' button in the top right corner to save your dbconfig.php file:<br>[[Image:CPanel-SaveChanges.png]] | ||
# Close the edit window. | # Close the edit window. | ||
---- | ---- | ||
Line 49: | Line 52: | ||
===Run the install script=== | ===Run the install script=== | ||
---- | ---- | ||
− | Open a new browser window. Surf to ''http://[your_AWBS_domain]/install/install.php'' (Substitute your domain name for [your_AWBS_domain])<br>Note: You must have read the AWBS license agreement and agree to abide by the terms to continue with the install. | + | Open a new browser window. Surf to ''http://[your_AWBS_domain]/install/install.php'' (Substitute your domain name for [your_AWBS_domain])<br>Note: You must have read the AWBS license agreement and agree to abide by the terms to continue with the install.<br>[[Image:AWBS-Agreement.png]]<br> |
− | Once you have read the license agreement, Check the box and click | + | Once you have read the license agreement, Check the box and click '''Begin Install''' |
'''Welcome: (License Check)''' | '''Welcome: (License Check)''' | ||
Line 56: | Line 59: | ||
The next step is to verify your license. You should see something like the following: | The next step is to verify your license. You should see something like the following: | ||
− | + | [[Image:AWBS-LicenseStatus.png]] | |
− | + | ||
− | + | ||
− | Once the license has been verified click the box at the bottom of the page | + | Once the license has been verified click the box at the bottom of the page labelled '''Continue With Install''' |
− | Note: Error 5 indicates the license.dat file is missing. Be sure you have uploaded the license.dat file to the same directory that you uploaded the AWBS files. | + | ''Note: Error 5 indicates the license.dat file is missing. Be sure you have uploaded the license.dat file to the same directory that you uploaded the AWBS files.<br/>Error 3 indicates your server cannot reach our license database via port 80. Ensure your server has internet access via port 80.'' |
− | + | ||
− | Error 3 indicates your server cannot reach our license database via port 80. Ensure your server has internet access via port 80. | + | |
'''Step 1:''' | '''Step 1:''' | ||
Line 70: | Line 69: | ||
The next step is to check your php.ini configuration settings and make sure everything is ready to go. | The next step is to check your php.ini configuration settings and make sure everything is ready to go. | ||
You should see something like the following: | You should see something like the following: | ||
− | + | <br>[[Image:AWBS-SystemChecks.png]]<br> | |
− | + | Once the above information has been tested, click the box at the bottom of the page labelled '''Continue to step 2''' | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | Once the above information has been tested, click the box at the bottom of the page | + | |
'''Step 2:''' | '''Step 2:''' | ||
Line 82: | Line 76: | ||
The next step is to check your database settings and make sure everything is ready to go. | The next step is to check your database settings and make sure everything is ready to go. | ||
You should see something like the following: | You should see something like the following: | ||
− | + | <br>[[Image:AWBS-DBCheck.png]]<br> | |
− | + | Once the above information has been tested, click the box at the bottom of the page labelled '''Continue to step 3''' | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | Once the above information has been tested, click the box at the bottom of the page | + | |
'''Step 3:''' | '''Step 3:''' | ||
Line 95: | Line 83: | ||
The next step is to check your database structure and make sure the database is ready to go. | The next step is to check your database structure and make sure the database is ready to go. | ||
You should see something like the following: | You should see something like the following: | ||
− | + | <br>[[Image:AWBS-DBStructureCreate.png]]<br> | |
− | Once the above information has been tested, click the box at the bottom of the page | + | Once the above information has been tested, click the box at the bottom of the page labelled '''Continue to step 4''' |
'''Step 4:''' | '''Step 4:''' | ||
The next step is to populate the database with your company's information. Fill in the following info and then continue. | The next step is to populate the database with your company's information. Fill in the following info and then continue. | ||
− | You will need to fill out the information | + | You will need to fill out the information shown below: |
− | + | <br>[[Image:AWBS-CompanyInfo.png]]<br> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
'''Server Settings''' | '''Server Settings''' | ||
Line 123: | Line 97: | ||
Do NOT enter a URL that does not contain your AWBS files! The URL must point to where you have uploaded the files. | Do NOT enter a URL that does not contain your AWBS files! The URL must point to where you have uploaded the files. | ||
If you alter the licensed domain name or subdomain, it will not match your license and you will have license errors. | If you alter the licensed domain name or subdomain, it will not match your license and you will have license errors. | ||
− | + | <br>[[Image:AWBS-ServerSettings.png]]<br> | |
Non-Secure URL: examples: http://[your_licensed_domain_name]/directory or http://[your_licensed_domain_name] or http://[your_licensed_subdomain] | Non-Secure URL: examples: http://[your_licensed_domain_name]/directory or http://[your_licensed_domain_name] or http://[your_licensed_subdomain] | ||
− | Note: The URL above should reflect the URL you surf to to get to your AWBS site. | + | Note: The URL above should reflect the URL you surf to to get to your AWBS site. |
+ | |||
+ | If making use of Portal Mode, select that option and enter the URL for your Front End site. | ||
'''Server Admin''' | '''Server Admin''' | ||
Line 133: | Line 109: | ||
'''''Remember this login!''''' | '''''Remember this login!''''' | ||
− | + | <br>[[Image:AWBS-SuperAdminInfo.png]]<br> | |
− | + | Once you have the above information filled out as needed, click the box at the bottom of the page labelled '''Continue to step 5''' | |
− | + | ||
− | + | ||
− | Once you have the above information filled out as needed, click the box at the bottom of the page | + | |
'''Step 5:''' | '''Step 5:''' | ||
Line 144: | Line 117: | ||
At this point, the basic install is complete. | At this point, the basic install is complete. | ||
+ | |||
+ | [[Image:AWBS-Complete.png]] | ||
Click the box labeled "Finish Install" | Click the box labeled "Finish Install" | ||
---- | ---- | ||
+ | |||
===Delete the install directory=== | ===Delete the install directory=== | ||
---- | ---- | ||
− | Go back to your cPanel browser window. Click on the Up one level link. | + | # Go back to your cPanel File Manager browser window. |
− | Click on the install directory name (not icon). | + | # Click on the Up one level link.<br>[[Image:CPanel-UpOneDir.png]] |
− | In the top right pane, click to delete this folder and all files under it link. | + | # Click on the install directory name (not icon).<br>[[Image:CPanel-InstallFolder.png]] |
+ | # In the top right pane, click to delete this folder and all files under it link.<br>[[Image:CPanel-DeleteFolder.png]] | ||
---- | ---- | ||
+ | |||
===Secure the admin, includes and tools directories=== | ===Secure the admin, includes and tools directories=== | ||
---- | ---- | ||
− | # In cPanel, close the file manager window. Click the Password Protect Directories icon. | + | # In cPanel, close the file manager window. Click the Password Protect Directories icon.<br>[[Image:CPanel-ProtectedFolders.png]] |
− | # Click on the admin directory name (not icon) | + | # In the Directory Selection box, use the Web Root.<br>[[Image:CPanel-PasswordDirSelect.png]] |
− | # Check the Directory requires a password to access via the web check box, (you must check this to activate password protection). | + | # Click on the admin directory name (not icon)<br>[[Image:CPanel-ProtectedFoldersSelect.png]] |
+ | # Check the Directory requires a password to access via the web check box, (you must check this to activate password protection).<br>[[Image:CPanel-SecuritySettingsFolderProtect.png]] | ||
# Enter some text as desired in the Protected Resource Name (will display in browser's password mask) | # Enter some text as desired in the Protected Resource Name (will display in browser's password mask) | ||
− | # Click the Save button. | + | # Click the '''Save''' button. |
− | # Click Go Back | + | # If successful you should see the following. Click the '''Go Back''' link.<br>[[Image:CPanel-PermissionsUpdated.png]] |
− | # Scroll down to the Active Users section. | + | # Scroll down to the '''Active Users''' section.<br>[[Image:CPanel-CreateUserFolderProtect.png]] |
# Enter a username in the User Name field and a password in the Password field. | # Enter a username in the User Name field and a password in the Password field. | ||
+ | # If successful you should see the following. Click the '''Go Back''' link.<br>[[Image:CPanel-AddUserAccepted.png]] | ||
+ | *Additional users can be added. | ||
+ | *Click the Add/modify authorized user button. | ||
− | Remember | + | '''Remember these logins will be needed by all who enter the protected directory. This will include any AWBS users who you give any admin rights to.''' |
− | + | '''Repeat above for the includes and tools directories.''' | |
− | + | ||
− | Repeat above for the includes and tools directories. | + | |
---- | ---- | ||
+ | |||
===Configure your cron jobs=== | ===Configure your cron jobs=== | ||
---- | ---- | ||
− | # From your cPanel home page, click on the cron jobs icon. | + | # From your cPanel home page, click on the cron jobs icon.<br>[[Image:CPanel-CronJobs.png]] |
− | + | # Enter an email address you will be able to check in the Please enter an email address where the cron output will be sent field.<br>[[Image:CPanel-CronEmail.png]] | |
− | # Enter an email address you will be able to check in the Please enter an email address where the cron output will be sent field. | + | |
# Edit the Minute and Hour fields so that you have scheduled for once per day at a low traffic time on your server. Example: If you enter 0 for Minute and 5 for Hour, this will run the updtransfers.php cron at 5:00 AM each day. | # Edit the Minute and Hour fields so that you have scheduled for once per day at a low traffic time on your server. Example: If you enter 0 for Minute and 5 for Hour, this will run the updtransfers.php cron at 5:00 AM each day. | ||
− | # Enter ''php -f /home/userdir/public_html/tools/updtransfers.php'' in the Command field. (Substitute your cPanel username in place of 'userdir' and do not paste the quotes) | + | # Enter ''php -f /home/userdir/public_html/tools/updtransfers.php'' in the Command field. (Substitute your cPanel username in place of 'userdir' and do not paste the quotes)<br>[[Image:CPanel-Updtransfers.png]] |
− | # Click the | + | # Click the '''Add New Cron Job''' button. |
# Configure the ''updateexp.php'' and ''invoice_cron.php'' files also for once per day, but at a different time than the ''updtransfers.php'' cron. You can copy the command field from the original, then just edit the file name ''updtransfers.php'' to ''updateexp.php'' and change the Hour, then save. | # Configure the ''updateexp.php'' and ''invoice_cron.php'' files also for once per day, but at a different time than the ''updtransfers.php'' cron. You can copy the command field from the original, then just edit the file name ''updtransfers.php'' to ''updateexp.php'' and change the Hour, then save. | ||
# Repeat for ''invoice_cron.php''.<br>NOTE: It is advised to run the ''invoice_cron.php'' after the ''updateexp.php'' and ''updtransfers.php'' files each day. | # Repeat for ''invoice_cron.php''.<br>NOTE: It is advised to run the ''invoice_cron.php'' after the ''updateexp.php'' and ''updtransfers.php'' files each day. | ||
− | # Repeat for ''master_cron.php'', however change the Minute field to */ | + | # Repeat for ''master_cron.php'', however change the Minute field to */10 and the Hour field to *. This will run the ''master_cron.php'' every 10 minutes.<br>[[Image:CPanel-MasterCron.png]] |
Once you are satisfied your crons are functioning properly (after configuring and testing your AWBS install), you can remove your email address to minimize your incoming emails. | Once you are satisfied your crons are functioning properly (after configuring and testing your AWBS install), you can remove your email address to minimize your incoming emails. | ||
Installation is complete, now you can login as super admin and start configuring, customizing and testing. | Installation is complete, now you can login as super admin and start configuring, customizing and testing. |
Latest revision as of 12:54, June 22, 2011
Contents
Easy cPanel Install
(Note: this page is based upon the cpanel x theme. Icons and links may have different but similar names/icons if you have another cpanel skin)
Login to cPanel
Create Database
- Click the MySQL Databases icon:
- In the Current Databases: section enter the desired database name in the New Database field:
- Click the Create Database button
- Click the Go Back link.
- In the Current Users section enter the desired username and password in the appropriate fields:
- Click the Create User button:
- Click the Go Back link.
- In the Add Users to Your Databases section, select the database you just created and the user you have just created in the dropdown boxes, then click the Add button
Verify that the ALL checkbox is checked for privileges:
- Click the Make Changes button.
- Document your db name, username and password for future reference.
Upload files
- Click on the Legacy File Manager icon.
- On the Directory selection window, leave as Web Root and click Go. (This tutorial assumes you are installing in the root of your site.)
- Click on Upload file(s):
- Click the first Choose File button, select the full install AWBS zip file that you downloaded from the AWBS download area.
- Click the second Choose File button, select the license.dat file you got when you purchased AWBS.
- Click the Upload button.
- When the upload is complete, click on the filename of the AWBS full install zip.
- In the top right pane, click Extract File Contents.
- Once the zip has been extracted, you can close the new tab or window that opened, and delete the Zip file.
Edit dbconfig.php file
- Refresh the File Manager page.
- Navigate into the includes directory by clicking the folder icon beside includes:
- Scroll down in the listing until you find dbconfig.php.
Click on the filename dbconfig.php: - In the top right pane, click Edit File with Code Editor.
- This block will open a new box which asks for the character encoding, it is best to leave it at us-ascii:
- Scroll down in this block until you see the Edit button. Click the Edit button:
- Find and Remove the $needs_edit=1; line:
- Find the Database information lines. This is where you will need the Database Name, Username, and Password as previously noted in the Create Database section.
- Edit these lines with your database information:
(Enter your information between the quotes in each line, overwriting the sample data that is there) - Find the Workdir information line:
- Edit this line with your correct path to your files:
Most cPanel servers paths would be like this:/home/userdir/public_html Substitute 'userdir' with your cPanel login username. - Find the Cookie Domain information line:
- Edit this line with your domain name preceded by a dot:
- Click the Save Changes button in the top right corner to save your dbconfig.php file:
- Close the edit window.
Run the install script
Open a new browser window. Surf to http://[your_AWBS_domain]/install/install.php (Substitute your domain name for [your_AWBS_domain])
Note: You must have read the AWBS license agreement and agree to abide by the terms to continue with the install.
Once you have read the license agreement, Check the box and click Begin Install
Welcome: (License Check)
The next step is to verify your license. You should see something like the following:
Once the license has been verified click the box at the bottom of the page labelled Continue With Install
Note: Error 5 indicates the license.dat file is missing. Be sure you have uploaded the license.dat file to the same directory that you uploaded the AWBS files.
Error 3 indicates your server cannot reach our license database via port 80. Ensure your server has internet access via port 80.
Step 1:
The next step is to check your php.ini configuration settings and make sure everything is ready to go.
You should see something like the following:
Once the above information has been tested, click the box at the bottom of the page labelled Continue to step 2
Step 2:
The next step is to check your database settings and make sure everything is ready to go.
You should see something like the following:
Once the above information has been tested, click the box at the bottom of the page labelled Continue to step 3
Step 3:
The next step is to check your database structure and make sure the database is ready to go.
You should see something like the following:
Once the above information has been tested, click the box at the bottom of the page labelled Continue to step 4
Step 4:
The next step is to populate the database with your company's information. Fill in the following info and then continue.
You will need to fill out the information shown below:
Server Settings
Edit the licensed urls if necessary. Add/Remove the www. as needed/desired, edit http and https as needed, and add any subdirectory information to the url. Do NOT add a trailing slash. If you don't have a secure site, use the same URL in both fields.
Do NOT enter a URL that does not contain your AWBS files! The URL must point to where you have uploaded the files.
If you alter the licensed domain name or subdomain, it will not match your license and you will have license errors.
Non-Secure URL: examples: http://[your_licensed_domain_name]/directory or http://[your_licensed_domain_name] or http://[your_licensed_subdomain]
Note: The URL above should reflect the URL you surf to to get to your AWBS site.
If making use of Portal Mode, select that option and enter the URL for your Front End site.
Server Admin
This is where you will establish the 'super admin' account and login. The password can be changed later.
Remember this login!
Once you have the above information filled out as needed, click the box at the bottom of the page labelled Continue to step 5
Step 5:
AWBS installation is complete!
At this point, the basic install is complete.
Click the box labeled "Finish Install"
Delete the install directory
- Go back to your cPanel File Manager browser window.
- Click on the Up one level link.
- Click on the install directory name (not icon).
- In the top right pane, click to delete this folder and all files under it link.
Secure the admin, includes and tools directories
- In cPanel, close the file manager window. Click the Password Protect Directories icon.
- In the Directory Selection box, use the Web Root.
- Click on the admin directory name (not icon)
- Check the Directory requires a password to access via the web check box, (you must check this to activate password protection).
- Enter some text as desired in the Protected Resource Name (will display in browser's password mask)
- Click the Save button.
- If successful you should see the following. Click the Go Back link.
- Scroll down to the Active Users section.
- Enter a username in the User Name field and a password in the Password field.
- If successful you should see the following. Click the Go Back link.
- Additional users can be added.
- Click the Add/modify authorized user button.
Remember these logins will be needed by all who enter the protected directory. This will include any AWBS users who you give any admin rights to.
Repeat above for the includes and tools directories.
Configure your cron jobs
- From your cPanel home page, click on the cron jobs icon.
- Enter an email address you will be able to check in the Please enter an email address where the cron output will be sent field.
- Edit the Minute and Hour fields so that you have scheduled for once per day at a low traffic time on your server. Example: If you enter 0 for Minute and 5 for Hour, this will run the updtransfers.php cron at 5:00 AM each day.
- Enter php -f /home/userdir/public_html/tools/updtransfers.php in the Command field. (Substitute your cPanel username in place of 'userdir' and do not paste the quotes)
- Click the Add New Cron Job button.
- Configure the updateexp.php and invoice_cron.php files also for once per day, but at a different time than the updtransfers.php cron. You can copy the command field from the original, then just edit the file name updtransfers.php to updateexp.php and change the Hour, then save.
- Repeat for invoice_cron.php.
NOTE: It is advised to run the invoice_cron.php after the updateexp.php and updtransfers.php files each day. - Repeat for master_cron.php, however change the Minute field to */10 and the Hour field to *. This will run the master_cron.php every 10 minutes.
Once you are satisfied your crons are functioning properly (after configuring and testing your AWBS install), you can remove your email address to minimize your incoming emails.
Installation is complete, now you can login as super admin and start configuring, customizing and testing.