Difference between revisions of "Amahi 7 Create Manual Web App"

From Amahi Wiki
Jump to: navigation, search
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{AdvancedUsers}}
+
{{MessageBox|
To accommodate those users who need the manual web app feature currently not available in Amahi 7, the following guidance is provided.  This has been tested and no issues were noted.  Please note this is <u>ONLY</u> a work around until the manual web app feature is implemented in Amahi 7.
+
backgroundcolor = #faa|
 
+
image =Warning.png|
Choose a name for your app.  It should be short, lowercase, and do not use spaces.  For example, <b>head_phones</b> or <b>headphones</b> are acceptable names.  (remember to replace all occurrences of <u>appname</u> below with your desired name).
+
heading =WARNING|
 
+
message =
<b>NOTE:</b>  There is no guarantee this will work for you or not cause problems with your Amahi 7 install.  Please proceed with caution as carelessness could render your HDA inoperable.
+
Amahi 7 or greater application [https://www.amahi.org/apps/web-apps Web App] provides this capability.}}
 
 
== Create Manual Web App ==
 
As [[Open_Terminal_as_root|root user]], perform the following steps:
 
* Build directory structure
 
<blockquote>{{code|mkdir -p /var/hda/web-apps/appname
 
mkdir -p /var/hda/web-apps/appname/html
 
mkdir -p /var/hda/web-apps/appname/logs
 
chown -R apache:users /var/hda/web-apps/appname
 
chown -R apache:users /var/hda/web-apps/appname/html
 
touch /var/hda/web-apps/appname/logs/access_log
 
touch /var/hda/web-apps/appname/logs/error_log
 
chown -R /var/hda/web-apps/appname/logs/access_log
 
chown -R /var/hda/web-apps/appname/logs/error_log}}</blockquote>
 
* Create Apache configuration file (9999 can be changed to any number, but recommend keep it above 2000 to be safe)
 
<blockquote>{{code|vi /etc/httpd/conf.d/9999-appname.conf}}</blockquote>
 
:Insert the text below (remember to change all occurrences of appname accordingly and the domain name amahi.net to match yours if needed)
 
<blockquote>{{text|<VirtualHost *:80>
 
 
 
        ServerName appname
 
        ServerAlias appname.amahi.net
 
 
 
        DocumentRoot /var/hda/web-apps/appname/html
 
 
 
        <Directory "/var/hda/web-apps/appname/html">
 
                Options Indexes FollowSymLinks MultiViews
 
                AllowOverride AuthConfig
 
                Require all granted
 
 
 
        </Directory>
 
 
 
        ErrorLog  /var/hda/web-apps/appname/logs/error_log
 
        CustomLog /var/hda/web-apps/appname/logs/access_log combined env<nowiki>=</nowiki>!dontlog
 
 
 
</VirtualHost>}}</blockquote>
 
:Change permissions and restart Apache
 
<blockquote>{{code|chown apache:users /etc/httpd/conf.d/9999-appname.conf
 
service httpd restart}}</blockquote>
 
* Update Amahi 7 database settings
 
**The id field is set to 99 for this example.  It can be any number not currently used by Amahi.  Recommend you keep it at 99 or greater to be safe.<br />
 
**Ensure you replace appname accordingly and the date can be changed providing you follow the format.  If you changed the .conf file name, ensure it matches as well.
 
**To do a quick check, you can do the following for each table:
 
<blockquote>{{code|echo "select max(id) from dns_aliases" <nowiki>|</nowiki> mysql -uroot -phda hda_production
 
echo "select max(id) from webapps" <nowiki>|</nowiki> mysql -uroot -phda hda_production}}</blockquote>
 
:Once you have chosen the id number, execute the following
 
<blockquote>{{code|echo "INSERT INTO `dns_aliases` (`id`, `name`, `address`) VALUES(99, 'appname', '')" <nowiki>|</nowiki> mysql -uroot -phda hda_production
 
echo "INSERT INTO `webapps` (`id`, `name`, `path`, `kind`, `aliases`, `fname`, `deletable`, `login_required`, `dns_alias_id`, `custom_options`, `created_at`, `updated_at`) VALUES(99, 'appname', '/var/hda/web-apps/appname', '', '', '9999-appname.conf', 0, 0, 99, NULL, '2013-11-17 12:00:00', '2013-11-17 12:00:00')" <nowiki>|</nowiki> mysql -uroot -phda hda_production}}</blockquote>
 
* Create a test file
 
<blockquote>{{code|vi /var/hda/web-apps/appname/html/index.html}}</blockquote>
 
:Insert the text below
 
<blockquote>{{text|<!DOCTYPE html>
 
<html>
 
<body>
 
 
 
<h1>Web App TEST Page</h1>
 
 
 
<p>It works!</p>
 
 
 
</body>
 
</html>}}</blockquote>
 
:Set the correct permissions on the file
 
<blockquote>{{code|chown apache:users /var/hda/web-apps/appname/html/index.html}}</blockquote>
 
* Test your new web app by entering <b><nowiki>http://appname</nowiki></b> in your browser.  If all goes well, you should see the test page.  If you have problems, retrace your steps.  Ensure you replaced all occurrences of appname accordingly and the id field in both tables match.
 
 
 
== Delete Manual Web App ==
 
The process to remove a web app created using the procedure above is a little shorter as you might expect.  The steps below will remove it completely from your Amahi 7 instance.
 
 
 
<b>NOTE:</b>  Please ensure you remove the correct files or you may break an existing web application.
 
 
 
As [[Open_Terminal_as_root|root user]], perform the following steps:
 
* Remove the Apache configuration file
 
<blockquote>{{code|rm -rf /etc/httpd/conf.d/9999-appname.conf}}</blockquote>
 
* Delete the web app directory
 
<blockquote>{{code|rm -rf /var/hda/web-apps/appname}}</blockquote>
 
* Restart Apache
 
<blockquote>{{code|service httpd restart}}</blockquote>
 
* Update Amahi 7 database settings<br />
 
<blockquote>{{code|echo "DELETE FROM `dns_aliases` where id=99" | mysql -uroot -phda hda_production
 
echo "DELETE FROM `webapps` id=99" | mysql -uroot -phda hda_production}}</blockquote>
 
:Once complete, the web app should now be completely removed from your system.
 

Latest revision as of 01:11, 25 March 2016

Warning.png WARNING
Amahi 7 or greater application Web App provides this capability.