Skip to content
This repository has been archived by the owner on Mar 4, 2021. It is now read-only.

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Gipetto committed Dec 16, 2011
1 parent 8deb668 commit b7386d3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
7 changes: 4 additions & 3 deletions INSTALL.markdown
Expand Up @@ -20,7 +20,7 @@ Installing OpenVBX is quick and easy, just follow this five step guide to get up

## Step 2: Create a Database

OpenVBX needs a database from either your hosting provider or your own web server. Please see your hosting provider's documentation on creating databases for more info.
OpenVBX needs a database from either your hosting provider or your own web server. Please see your hosting provider's documentation on creating databases for more info.


## Step 3: Run the Installer
Expand Down Expand Up @@ -53,7 +53,7 @@ Add this to the bottom of `OpenVBX/config/config.php`:
$config['uri_protocol'] = 'REQUEST_URI';
$config['index_page'] = '';

If you're still having issues at this point, modify your `.htaccess` file to be the following:
If you're still having issues at this point, modify the `IfModule mod_rewrite.c` section of your `.htaccess` file to be the following:

RewriteEngine ON

Expand Down Expand Up @@ -91,7 +91,8 @@ OpenVBX requires the software listed below. It is all available for free and is
1. **CURL support:** OpenVBX requires CURL. If you don't meet this requirement, install the CURL module.
1. **Apache version:** We recommend Apache version 2.2+. Earlier versions and other web servers may work, but are currently unsupported.
1. **MySQL support:** We require MySQL version 5+.
1. **APC support (optional):** APC is recommended, but not required.
1. **APC support (optional):** APC is recommended and can be used for caching, but not required.
1. **Memcache support (optional):** Memcache can be used for caching, but is not required.
1. **Config directory writable:** The configuration directory must be writable by the user your webserver is running as for the OpenVBX installation to complete. The path to the configuration directory is `<webroot>/OpenVBX/config`. On unix systems you can adjust the permissions with the `chown` and `chmod` commands.
1. **SimpleXML support:** OpenVBX requires SimpleXML. If you don't meet this requirement, install the SimpleXML module.
1. **JSON support:** OpenVBX requires JSON. If you don't meet this requirement install the JSON module.
Expand Down
8 changes: 6 additions & 2 deletions UPGRADE.markdown
Expand Up @@ -7,9 +7,9 @@ Upgrading OpenVBX is easy, just follow the steps below to upgrade your install.

## Backup First

The first thing to before upgrading any software is to make backup copies of your code and your data.  How you can accomplish this depends on your hosting provider.  If you have shell access you can just use mysqldump to make an export of your database.  If you don't have shell access than you probably have a control panel like cPanel.
The first thing to before upgrading any software is to make backup copies of your code and your data. How you can accomplish this depends on your hosting provider. If you have shell access you can just use mysqldump to make an export of your database. If you don't have shell access than you probably have a control panel like cPanel.

Make a backup copy of your database and your OpenVBX installation because there are uploaded audio files and configuration files in there.  You should also download these backups to your computer or upload them to DropBox or JungleDisk for safe keeping.
Make a backup copy of your database and your OpenVBX installation because there are uploaded audio files and configuration files in there. You should also download these backups to your computer or upload them to DropBox or JungleDisk for safe keeping.


## Upload OpenVBX
Expand All @@ -18,13 +18,15 @@ The next step is to get the latest version of OpenVBX from the [OpenVBX GitHub R

Upload the archive NEXT to your current install of OpenVBX. Do not overwrite the current install of OpenVBX.


### Via FTP

1. Go to the GitHub repository, click on the "Downloads" button in the upper right. A small popup window will appear. Click on one of the two Download links at the top of popup to download your preferred archive format.
1. Upload the code to the server.
* If your host allows you to run commands via your FTP client and your FTP client can expand archives then simply upload the archive to your host and expand it there.
* If you cannot expand the archive on the server then expand it on your local computer and upload the expanded folder to your host. This will be a bit slower, but will work just the same.


### Via curl/wget

If you have shell access to your server then you can bypass FTP and directly download and expand the archive on the server. Download your preferred archive format via `curl` or `wget`. The current production ready version of OpenVBX will always be available at:
Expand All @@ -37,6 +39,7 @@ If you have shell access to your server then you can bypass FTP and directly dow

You should now have your old OpenVBX install and your new OpenVBX install sitting next to each other in the same directory. We now need to copy your configuration and audio uploads to the new install.


### Configuration Files

**Copy** the following files from your old install to your new install:
Expand All @@ -50,6 +53,7 @@ If you've modified the following files, copy them to the new install as well. Th

* `.htaccess`


### Audio Uploads

**Copy** the files from your old `audio-uploads/` directory to your new `audio-uploads/` directory.
Expand Down

0 comments on commit b7386d3

Please sign in to comment.