Skip to content

Update the installation documentation #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −30
Open

Update the installation documentation #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 16 additions & 17 deletions installation/install-on-ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ These instructions will walk you through setting up LAMP (Linux Apache Mysql PHP

**Note**

mysql and mariadb have diverged somewhat in base functionality. Whereas MariaDB and MySQL were interchangable in previous releases, now only MariaDB is supported. If you need to move from MySQL to MariaDB it's as simple as installing MariaDB over MySQL. 
MySQL and MariaDB have diverged somewhat in base functionality. Whereas MariaDB and MySQL were interchangeable in previous releases, now only MariaDB is supported. If you need to move from MySQL to MariaDB it's as simple as installing MariaDB over MySQL. 

* `$ sudo apt-get update`
* `$ sudo apt-get install mariadb-server mariadb-client`
Expand All @@ -15,7 +15,7 @@ mysql and mariadb have diverged somewhat in base functionality. Whereas MariaDB
* `$ sudo apt-get install apache2`

**Note for PHP 7.2**\
****Versions higher than PHP7.2 are not currently supported
****Versions higher than PHP 7.2 are not currently supported



Expand All @@ -38,7 +38,7 @@ sudo update-alternatives --set php /usr/bin/php7.2
```

* `$ sudo apt-get install php7.2 php7.2-soap php7.2-ldap`
* `$ sudo apt-get install php7.2-mysqli php7.2-gd php7.2-xml`
* `$ sudo apt-get install php7.2-mysql php7.2-gd php7.2-xml`
* `$ sudo apt-get install php7.2-curl php7.2-mbstring php7.2-zip`
* `$ sudo service apache2 restart`

Expand All @@ -48,15 +48,17 @@ sudo update-alternatives --set php /usr/bin/php7.2

**This is the backend database that stores all your OpenCATS information. You likely will NOT be messing with this much after installation unless you choose to. The login/password you set up here will NOT be the same as your login/password for OpenCATS.**

**NOTE: The default encoding for new databases in MariaDB is latin-1 which will have problems with non-english characters. If you will encounter any non-english characters, please creaet your databases with UTF-8 encoding (shown in bold, below)**
**NOTE: The default encoding for new databases in MariaDB is latin-1 which will have problems with non-english characters. If you will encounter any non-English characters, please create your databases with UTF-8 encoding (shown in bold, below)**

* `$ sudo mysql -u root -p`

It will ask you for your Ubuntu Root password
It will ask you for your Ubuntu user password

Then it will ask you for your mysql root password
Then it will ask you for your MySQL/MariaDB root password

* You should see a prompt like this: `MariaDB [(none)]>`
You should see a prompt like this: `MariaDB [(none)]>`

Now let's create a database for OpenCATS:
* MariaDB \[(none)]> `CREATE USER` [`‘opencats’@’localhost`](mailto:'opencats'%40'localhost)`’ IDENTIFIED BY ‘databasepassword’;`
* MariaDB \[(none)]> `CREATE DATABASE opencats;`\
OR WITH UTF-8; **`CREATE DATABASE opencats CHARACTER SET utf8 COLLATE utf8_general_ci`**`;` 
Expand All @@ -70,26 +72,23 @@ Make sure you don’t forget the ; on the end of every line!
### Download the OpenCATS files[¶](broken-reference)

* `$ cd /var/www/html`
* `$ sudo wget`[`https://github.com/opencats/OpenCATS/releases/download/0.9.6/opencats-0.9.6-full.zip`](https://github.com/opencats/OpenCATS/releases/download/0.9.6/opencats-0.9.6-full.zip)``
* `$ sudo unzip opencats-0.9.6-full.zip`
* `$ sudo mv opencats-0.9.6 opencats`
* `$ rm /var/www/html/opencats/INSTALL_BLOCK`
* `$ sudo wget` [`https://github.com/opencats/OpenCATS/releases/download/v0.9.7.2/OpenCATS-v0.9.7.2-FULL.zip`](https://github.com/opencats/OpenCATS/releases/download/v0.9.7.2/OpenCATS-v0.9.7.2-FULL.zip)``
* `$ sudo unzip OpenCATS-v0.9.7.2-FULL.zip`
* `$ sudo mv OpenCATS opencats`
* `$ sudo rm /var/www/html/opencats/INSTALL_BLOCK`

Note

By default in this documentation for OpenCATS version 0.9.6 the directory would be `opencats`. You can name it whatever you want. Just remember that all of the directory locations from here on must match the name of the directory you create, including capitol letters.
Following the steps in this documentation, the directory name will be `opencats`. You can rename it whatever you want. Just remember that all of the directory locations from here on must match the name of the directory you create, including capital letters.

Note

If you have tried installing OpenCATS before, or for any reason see something called INSTALL\_BLOCK in this directory, you MUST delete it. This will prevent OpenCATS from running the installer. The command for that would be `$ sudo rm INSTALL_BLOCK`.
If you have tried installing OpenCATS before, or for any reason see something called INSTALL\_BLOCK in this directory, you MUST delete it. This will prevent OpenCATS from running the installer. The command for that would be `$ sudo rm INSTALL_BLOCK`

### Server and Directory permissions[¶](broken-reference)

* `$ sudo chown www-data:www-data opencats`
* `$ sudo chown -R www-data:www-data opencats`
* `$ sudo chmod 770 opencats/attachments`
* `$ sudo chmod 770 opencats/upload`
* `$ sudo chmod 770 opencats/attachments opencats/upload`

Now go to [Run the installer](run-the-installer.md)

###
26 changes: 13 additions & 13 deletions installation/install-on-windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Note

You need to run MariaDB 10 and PHP 7.2, if there are various XAMPP options available, get the one with these package versions!!

* Download - [OpenCATS-0.9.6-FULL](https://github.com/opencats/OpenCATS/releases/download/0.9.6/opencats-0.9.6-full.zip). You can not install this yet.
* Download - [OpenCATS-v0.9.7.2-FULL](https://github.com/opencats/OpenCATS/releases/download/v0.9.7.2/OpenCATS-v0.9.7.2-FULL.zip). You can not install this yet.
* Extract the file to `C:xampp\htdocs` 


Expand All @@ -26,23 +26,23 @@ You need to run MariaDB 10 and PHP 7.2, if there are various XAMPP options avail

Note

ONLY start the Apache and MySql services. You do NOT need any of the other services.
ONLY start the Apache and MySQL services. You do NOT need any of the other services.

![\_images/start-services-xampp.png](<../../.gitbook/assets/start services xampp>)

* Stop the apache service (lower right corner, right click XAMPP, stop apache)
* Start the apache service
* Stop the Apache service (lower right corner, right click XAMPP, stop apache)
* Start the Apache service

### OPTIONAL - Renaming your OpenCATS directory[¶](broken-reference)

The current default directory name for the OpenCATS files is OpenCATS-0.9.6. This will result in the web address in your browser being [http://localhost/OpenCATS-0.9.](http://localhost/OpenCATS-0.9.4-3)6
The current default directory name is `OpenCATS`. This will result in the web address in your browser being [http://localhost/OpenCATS](http://localhost/OpenCATS)

If you want to rename the main OpenCATS directory to something else, you can do it now.
If you want to rename the main OpenCATS directory to something else, here's how to do it:

* Simply navigate to `C:\xampp\htdocs`
* Right click on the OpenCATS directory
* Navigate to `C:\xampp\htdocs`
* Right click on the `OpenCATS` directory
* Click `rename`
* Rename the directory whatever you want (example: ATS)
* Rename the directory whatever you want (example: `ATS`)

Now, to access it, your browser address will be [http://localhost/ATS](http://localhost/ATS)

Expand All @@ -52,7 +52,7 @@ Now, to access it, your browser address will be [http://localhost/ATS](http://lo

Note

If phpmyadmin does not load in this screen, stop and start your apache service again per the instructions above.
If phpMyAdmin does not load in this screen, stop and start your Apache service again per the instructions above.

* On the left side, click `new` to create a new database

Expand All @@ -61,7 +61,7 @@ If phpmyadmin does not load in this screen, stop and start your apache service a
* In the box labelled `database name` type `opencats`.
* Hit `create`

**NOTE: The default encoding for new databases in MariaDB is latin-1 which will have problems with non-english characters. If you will encounter any non-english characters, please create your databases and select UTF-8 encoding and collation;**\
**NOTE: The default encoding for new databases in MariaDB is latin-1 which will have problems with non-English characters. If you will encounter any non-English characters, please create your databases and select UTF-8 encoding and collation;**\
****\
******CHARACTER SET utf8** \
**COLLATION utf8\_general\_ci**;&#x20;
Expand All @@ -70,15 +70,15 @@ If phpmyadmin does not load in this screen, stop and start your apache service a

You should now see “opencats” listed among the databases on the left.

* Click the opencats database
* Click the `opencats` database
* In the top row of tabs, on the right side of the screen, click `privileges`
* Click `add user account`

![\_images/phpmyadmin-newuser.png](<../../.gitbook/assets/phpmyadmin newuser>)

* User name, make sure `use text field` is selected, in the empty box next to it type `opencats`
* Host name: In the first box, select `local` from the drop-down options. The second box should say `localhost`
* Type opencats for the database password twice
* Type `opencats` for the database password twice
* In the “database for user account section”, confirm that the third checkbox `Grant all privileges on database "opencats"` is checked.
* Scroll down to the bottom and click `go`

Expand Down