# ## Licensed to the Apache Software Foundation (ASF) under one ## or more contributor license agreements. See the NOTICE file ## distributed with this work for additional information ## regarding copyright ownership. The ASF licenses this file ## to you under the Apache License, Version 2.0 (the ## "License"); you may not use this file except in compliance ## with the License. You may obtain a copy of the License at ## ## http://www.apache.org/licenses/LICENSE-2.0 ## ## Unless required by applicable law or agreed to in writing, ## software distributed under the License is distributed on an ## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY ## KIND, either express or implied. See the License for the ## specific language governing permissions and limitations ## under the License. ## If you have not yet performed the steps outlined in README.txt, stop here and go through the README.txt directions before proceeding. Lokahi is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. =========================== Getting Started with Lokahi =========================== After building and installing the software, Lokahi requires some initial objects to be added to the database before you can use Lokahi to manage web applications. The following items must be performed through the GUI. ============================ Add Infrastructure to Lokahi ============================ (1) Add your environments (development, test, production, etc.) Click: Administration >> Manage Lokahi >> Manage Environments >> Select Action >> Add Environment (2) Add Servers (2.1) Add Apache head-matter file Click: Administration >> Manage Lokahi >> Manage Files >> Add Paste in the head matter of your httpsd.conf file, excluding VirtualHosts, Listens, and catchalls. The ApachePools you'll create later will be based on one of the head matter files you're creating here. Give the file a name that denotes its use in your environment, perhaps specifying whether it is your standard, or how its module list deviates from your usual standard. For example, if you have an instance of Apache in your environment that does not include mod_, add that head-matter as a separate file. (2.2) Create Apache server template Click: Infrastructure >> Servers >> View Apaches >> Select Action >> Add (2.3) Add Tomcat JVM template Infrastructure >> Servers >> View Tomcat >> Select Action >> Add (2.4) Add Hardwares Click: Infrastructure >> Servers >> View Hardwares >> Select Action >> Add (3) Add Pools (3.1) Create Apache pool Click: Infrastructure >> Pools >> Select One >> Add Apache Pool (3.2) Create Tomcat pool Click: Infrastructure >> Pools >> Select One >> Add Tomcat Pool (3.3) Create hosting pool Infrastructure >> Pools >> Select One >> Add Hosting Pool =============================== Add a Web Application to Lokahi =============================== (1) Add a Project Click: Projects >> Add and enter the name of your project. (2) Add a VirtualHost to the project you created. Click: >> Select Action >> Add a VirtualHost (2.1) Select a HostingPool from the menu. (2.2) If you want to set up a Tomcat context, click "Add Another." Otherwise, continue. (Another method of adding a Tomcat context is detailed in Step 3.) (2.3) In the ServerName field, enter a domain name. (2.4) In the Entry field, add Apache directives for the web application, one per line. (2.5) If you are also setting up a Tomcat context, enter the context name and DocBase path in the appropriate fields. (2.6) Click submit. Lokahi will generate the VirtualHost entry, insert it into the database, build the apache httpsd.conf file (and the jvm.conf and server.xml files if you added a context), and deploy it to the hardware you added. (3) Add a Context Click: Projects >> Search to locate the project to which you want to add a context. or Click: Projects >> Add to create a new project to which you will add a context. (3.1) Click >> Select Action >> Add a Context and enter the context name and the DocBase path. You can add a context to a VirtualHost by choosing "Add a Context" from the VirtualHosts's own menu, or you can just add the context to a project without connecting it to a VirtualHost. (4) Add a user Click: >> Select Action (from the project menu) >> Add a User. (4.1) Enter the user ID, and choose the environment(s) in which to grant the user permissions. (4.2) Check off the options you want to grant to the user.