Skip to content

Latest commit

 

History

History
589 lines (493 loc) · 17.9 KB

INSTALL.md

File metadata and controls

589 lines (493 loc) · 17.9 KB
Raw

Ophal installation instructions

This document is just a brief. For a comprenhensive installation guide please refer to the online Ophal manual: http://ophal.org/manual.

I. Server configuration

This instructions assume that you installed Ophal at /var/www/ophal.

Ophal can run on native Nginx's HttpLuaModule or as a humble CGI script on Apache, Lighttpd and others that support CGI and URL rewriting. FastCGI support can be implemented with a FastCGI wrapper on Apache, Nginx, Lighttpd and several other web servers.

NOTE: Ophal is compatible with SQLite and PostgreSQL only.

Apache

Enable mod_rewrite and mod_cgi, then use following configuration for reference:

Sub-directory

Alias /lua /var/www/ophal/
<Directory "/var/www/ophal">
  AllowOverride All
  Options Indexes FollowSymLinks MultiViews +ExecCGI
  Order allow,deny
  Allow from all
</Directory>

Virtualhost

<VirtualHost *:80>
  ServerAlias ophal

  DocumentRoot /var/www/ophal
  <Directory />
    Options FollowSymLinks
    AllowOverride None
  </Directory>
  <Directory /var/www/ophal/>
    Options Indexes FollowSymLinks MultiViews +ExecCGI
    AllowOverride All
    Order allow,deny
    allow from all
  </Directory>

  ErrorLog /var/log/apache2/ophal-error.log

  # Possible values include: debug, info, notice, warn, error, crit,
  # alert, emerg.
  LogLevel debug

  CustomLog /var/log/apache2/ophal-access.log combined
</VirtualHost>

Lighttpd

Install mod_magnet and use the file lighttpd.ophal.lua to configure your server. Also, enable module cgi. Then use following configuration for reference:

$HTTP["host"] =~ ".+\.ophal" {
  evhost.path-pattern = "/var/www/%_/"
  index-file.names = ("index.cgi")
  cgi.assign = ( ".cgi" => "/usr/local/bin/luajit" )
  magnet.attract-physical-path-to = ("/etc/lighttpd/lighttpd.ophal.lua")
}

Notice that configuration above assumes that you are using "luajit".

Nginx

Install HttpLuaModule and use the file nginx.ophal.conf to configure your server. Make sure to set 'server_name' and 'root' correctly.

II. Dependencies

LuaJIT or Lua?

Ophal uses Lua 5.1 by default, but is compatible with LuaJIT 2.x if you prefer it. You need to edit the first line of index.cgi in order to switch interpreter.

Debian

$ sudo luarocks install lpeg
$ sudo apt-get install uuid-dev
$ sudo luarocks install luuid
$ sudo luarocks install luafilesystem
$ sudo luarocks install luasocket
$ cd /tmp
$ git clone --depth=1 git://github.com/ophal/seawolf.git
$ sudo mv seawolf /usr/local/share/lua/5.1/

III. Installation wizard

Open your Ophal installation in a web browser, you should be redirected to the Installation Wizard, follow the instructions. The wizard will check dependencies and ask for configuration parameters, then will generate a settings.lua for you, copy the text, store as settings.lua into the same directory of index.cgi, make the desired changes an set it to read-only.

(Optional) Configure the Content module

Run the following SQL queries in strict order:

####SQLite

CREATE TABLE content(
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  user_id UNSIGNED BIG INT,
  language VARCHAR(12),
  title VARCHAR(255),
  teaser TEXT,
  body TEXT,
  created UNSIGNED BIG INT,
  changed UNSIGNED BIG INT,
  status BOOLEAN,
  sticky BOOLEAN,
  comment BOOLEAN,
  promote BOOLEAN
);
CREATE INDEX idx_content_created ON content (created DESC);
CREATE INDEX idx_content_changed ON content (changed DESC);
CREATE INDEX idx_content_frontpage ON content (promote, status, sticky, created DESC);
CREATE INDEX idx_content_title ON content (title);
CREATE INDEX idx_content_user ON content (user_id);

####PostgreSQL

CREATE TABLE content(
  id integer NOT NULL,
  user_id bigint,
  language character varying(12),
  title character varying(255),
  teaser text,
  body text,
  created bigint,
  changed bigint,
  status smallint,
  sticky smallint,
  comment smallint,
  promote smallint
);
CREATE SEQUENCE content_id_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1;
ALTER SEQUENCE content_id_seq OWNED BY content.id;
ALTER TABLE ONLY content ALTER COLUMN id SET DEFAULT nextval('content_id_seq'::regclass);
ALTER TABLE ONLY content ADD CONSTRAINT content_pkey PRIMARY KEY (id);
CREATE INDEX idx_content_changed ON content USING btree (changed DESC);
CREATE INDEX idx_content_created ON content USING btree (created DESC);
CREATE INDEX idx_content_frontpage ON content USING btree (promote, status, sticky, created DESC);
CREATE INDEX idx_content_title ON content USING btree (title);
CREATE INDEX idx_content_user ON content USING btree (user_id);

Add the following to settings.lua:

settings.content = {
  entities = {},
  items_per_page = 10, -- default: 10
}

Also, make sure to enable and configure the User module.

NOTE: Ophal is compatible with SQLite only.

(Optional) Configure the Comment module

Run the following SQL queries in strict order:

####SQLite

CREATE TABLE comment(
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  entity_id UNSIGNED BIG INT, -- Entity associated with this object
  parent_id UNSIGNED BIG INT, -- Parent object
  user_id UNSIGNED BIG INT, -- User ID of author
  language VARCHAR(12), -- Language code
  body TEXT, -- Comment body
  created UNSIGNED BIG INT, -- Creation date
  changed UNSIGNED BIG INT, -- Last change date
  status BOOLEAN,
  sticky BOOLEAN
);
CREATE INDEX idx_comment_created ON comment (created DESC);
CREATE INDEX idx_comment_changed ON comment (changed DESC);
CREATE INDEX idx_comment_linear ON comment (entity_id, status);
CREATE INDEX idx_comment_linear_sticky ON comment (entity_id, status, sticky);
CREATE INDEX idx_comment_full_linear ON comment (entity_id);
CREATE INDEX idx_comment_full_linear_sticky ON comment (entity_id, sticky);
CREATE INDEX idx_comment_tree ON comment (parent_id, status);
CREATE INDEX idx_comment_tree_sticky ON comment (parent_id, status, sticky);
CREATE INDEX idx_comment_full_tree ON comment (parent_id);
CREATE INDEX idx_comment_full_tree_sticky ON comment (parent_id, sticky);
CREATE INDEX idx_comment_user ON comment (user_id);

####PostgreSQL

CREATE TABLE comment(
  id integer NOT NULL,
  entity_id bigint, -- Entity associated with this object
  parent_id bigint, -- Parent object
  user_id bigint, -- User ID of author
  language character varying(12), -- Language code
  body text, -- Comment body
  created bigint, -- Creation date
  changed bigint, -- Last change date
  status smallint,
  sticky smallint
);
CREATE SEQUENCE comment_id_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1;
ALTER SEQUENCE comment_id_seq OWNED BY comment.id;
ALTER TABLE ONLY comment ALTER COLUMN id SET DEFAULT nextval('comment_id_seq'::regclass);
ALTER TABLE ONLY comment ADD CONSTRAINT comment_pkey PRIMARY KEY (id);
CREATE INDEX idx_comment_created ON comment USING btree (created DESC);
CREATE INDEX idx_comment_changed ON comment USING btree (changed DESC);
CREATE INDEX idx_comment_linear ON comment USING btree (entity_id, status);
CREATE INDEX idx_comment_linear_sticky ON comment USING btree (entity_id, status, sticky);
CREATE INDEX idx_comment_full_linear ON comment USING btree (entity_id);
CREATE INDEX idx_comment_full_linear_sticky ON comment USING btree (entity_id, sticky);
CREATE INDEX idx_comment_tree ON comment USING btree (parent_id, status);
CREATE INDEX idx_comment_tree_sticky ON comment USING btree (parent_id, status, sticky);
CREATE INDEX idx_comment_full_tree ON comment USING btree (parent_id);
CREATE INDEX idx_comment_full_tree_sticky ON comment USING btree (parent_id, sticky);
CREATE INDEX idx_comment_user ON comment USING btree (user_id);

Add the following to settings.lua:

settings.comment = {
  entities = {
    content = true,
  },
}

Also, make sure to enable and<Virtual configure the User module.

NOTE: Ophal is compatible with SQLite only.

(Optional) Configure the User module

WARNING! Since the user module allows to start an authenticated session, meaning that certain users will have access to priviledged data, the use of an SSL certificated and HTTPS is strongly recommended. Please make sure that your production server running an Ophal site (with user module enable) is correctly configured for secure connections.

Run the following SQL queries in strict order:

  1. Create schema:

####SQLite

CREATE TABLE users(
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  name VARCHAR(255),
  mail VARCHAR(255),
  pass VARCHAR(255),
  active BOOLEAN,
  created UNSIGNED BIG INT
);
CREATE UNIQUE INDEX unq_idx_user_name ON users (name);
CREATE INDEX idx_user_created ON users (created);
CREATE INDEX idx_user_mail ON users (mail);

CREATE TABLE role(
  id VARCHAR(255) PRIMARY KEY,
  name VARCHAR(255),
  active BOOLEAN,
  weight INT
);
CREATE UNIQUE INDEX unq_idx_role_name ON role (name);
CREATE INDEX idx_role_weight ON role (weight);

CREATE TABLE user_role(
  user_id UNSIGNED BIG INT,
  role_id VARCHAR(255),
  PRIMARY KEY (user_id, role_id)
);

CREATE TABLE role_permission(
  role_id VARCHAR(255),
  permission VARCHAR(255),
  PRIMARY KEY (role_id, permission)
);
CREATE INDEX idx_role_permission_perm ON role_permission (permission);

####PostgreSQL

CREATE TABLE users(
  id integer NOT NULL,
  name character varying(255),
  mail character varying(255),
  pass character varying(255),
  active smallint,
  created bigint
);
CREATE SEQUENCE users_id_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1;
ALTER SEQUENCE users_id_seq OWNED BY users.id;
ALTER TABLE ONLY users ALTER COLUMN id SET DEFAULT nextval('users_id_seq'::regclass);
ALTER TABLE ONLY users ADD CONSTRAINT users_pkey PRIMARY KEY (id);
CREATE UNIQUE INDEX unq_idx_user_name ON users USING btree (name);
CREATE INDEX idx_user_created ON users USING btree (created);
CREATE INDEX idx_user_mail ON users USING btree (mail);

CREATE TABLE role (
  id character varying(255) NOT NULL,
  name character varying(255),
  active smallint,
  weight integer
);
ALTER TABLE ONLY role ADD CONSTRAINT role_pkey PRIMARY KEY (id);
CREATE UNIQUE INDEX unq_idx_role_name ON role USING btree (name);
CREATE INDEX idx_role_weight ON role USING btree (weight);

CREATE TABLE user_role (
  user_id bigint NOT NULL,
  role_id character varying(255) NOT NULL
);
ALTER TABLE ONLY user_role ADD CONSTRAINT user_role_pkey PRIMARY KEY (user_id, role_id);

CREATE TABLE role_permission (
  role_id character varying(255) NOT NULL,
  permission character varying(255) NOT NULL
);
ALTER TABLE ONLY role_permission ADD CONSTRAINT role_permission_pkey PRIMARY KEY (role_id, permission);
CREATE INDEX idx_role_permission_perm ON role_permission USING btree (permission);
  1. Generate a password for superuser with following script (requires ophal-cli):
$ ophal sha256 mypassword
89e01536ac207279409d4de1e5253e01f4a1769e696db0d6062ca9b8f56767c8

Alternatively, you can run the following lua code:

> print(require 'lsha2'.hash256 'mypassword')
89e01536ac207279409d4de1e5253e01f4a1769e696db0d6062ca9b8f56767c8

NOTICE: this script outputs a password hash, change 'mypassword' by 'yourpass'

  1. Create user 1:

####SQLite

INSERT INTO users VALUES(1, 'root', '[email protected]', 'your password hash', 1, strftime('%s', 'now'));

####PostgreSQL

INSERT INTO users VALUES(1, 'root', '[email protected]', 'your password hash', 1, extract(epoch from now() at time zone 'utc'));
  1. Enable Form API:
settings.formapi = true
  1. Enable this module:
settings.modules.user = true
  1. Configure default roles

You can either add the following to your settings.lua

--[[
  User module options
]]
settings.user = {
  entities = {
    content = true,
  },
  permissions_storage = true,
  -- algorithm = 'sha256', -- Be careful!
  permissions = {
    anonymous = {
      'access content',
    },
    authenticated = {
      'access content',
      'create content',
      'edit own content',
    },
  }
}

Or run the following SQL queries (valid for SQLite and PostgreSQL):

INSERT INTO role_permission VALUES('anonymous', 'access content', 'user');
INSERT INTO role_permission VALUES('authenticated', 'access content', 'user');
INSERT INTO role_permission VALUES('authenticated', 'create content', 'user');
INSERT INTO role_permission VALUES('authenticated', 'edit own content', 'user');

(Optional) Configure the Tag module

Run the following SQL queries in strict order:

####SQLite

CREATE TABLE field_tag(
  entity_type VARCHAR(255),
  entity_id BIG INT,
  tag_id BIG INT,
  PRIMARY KEY (entity_type, entity_id, tag_id)
);

CREATE TABLE tag(
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  user_id BIG INT,
  name VARCHAR(255),
  language VARCHAR(12), -- Language code
  description TEXT, -- Tag description
  created UNSIGNED BIG INT, -- Creation date
  changed UNSIGNED BIG INT, -- Last change date
  status BOOLEAN
);
CREATE UNIQUE INDEX unq_idx_tag_name ON tag (name);
CREATE INDEX idx_tag_user ON tag (user_id);
CREATE INDEX idx_tag_created ON tag (created DESC);
CREATE INDEX idx_tag_changed ON tag (changed DESC);

####PostgreSQL

CREATE TABLE field_tag(
  entity_type character varying(255) NOT NULL,
  entity_id bigint NOT NULL,
  tag_id bigint NOT NULL
);
ALTER TABLE ONLY field_tag ADD CONSTRAINT field_tag_pkey PRIMARY KEY (entity_type, entity_id, tag_id);

CREATE TABLE tag(
  id integer NOT NULL,
  user_id bigint,
  name character varying(255),
  language character varying(12), -- Language code
  description text, -- Tag description
  created bigint, -- Creation date
  changed bigint, -- Last change date
  status smallint
);
CREATE SEQUENCE tag_id_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1;
ALTER SEQUENCE tag_id_seq OWNED BY tag.id;
ALTER TABLE ONLY tag ALTER COLUMN id SET DEFAULT nextval('tag_id_seq'::regclass);
ALTER TABLE ONLY tag ADD CONSTRAINT tag_pkey PRIMARY KEY (id);
CREATE UNIQUE INDEX unq_idx_tag_name ON tag USING btree (name);
CREATE INDEX idx_tag_user ON tag USING btree (user_id);
CREATE INDEX idx_tag_created ON tag USING btree (created DESC);
CREATE INDEX idx_tag_changed ON tag USING btree (changed DESC);

Add the following to settings.lua:

settings.tag = {
  entities = {
    content = true,
  },
  items_per_page = 10, -- default: 10
}

Also, make sure to enable and configure the Content module.

(Optional) Configure the route aliases database storage

Complementary to the use of route_register_alias(), you can store route aliases into the database. This is specially useful for sites that make extensive use of semantic urls (i.e: /my-rocking-article instead of /content/7).

  1. Run the following SQL queries in strict order:

####SQLite

CREATE TABLE route_alias(
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  source VARCHAR(255),
  alias VARCHAR(255),
  language VARCHAR(12)
);
CREATE INDEX idx_route_alias_alias_language_id ON route_alias (alias, language, id);
CREATE INDEX idx_route_alias_source_language_id ON route_alias (source, language, id);

####PostgreSQL

CREATE TABLE route_alias(
  id integer NOT NULL,
  source character varying(255),
  alias character varying(255),
  language character varying(12)
);
CREATE SEQUENCE route_alias_id_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1;
ALTER SEQUENCE route_alias_id_seq OWNED BY route_alias.id;
ALTER TABLE ONLY route_alias ALTER COLUMN id SET DEFAULT nextval('route_alias_id_seq'::regclass);
ALTER TABLE ONLY route_alias ADD CONSTRAINT route_alias_pkey PRIMARY KEY (id);
CREATE INDEX idx_route_alias_alias_language_id ON route_alias USING btree (alias, language, id);
CREATE INDEX idx_route_alias_source_language_id ON route_alias USING btree (source, language, id);
  1. Enable database storage for route aliases
--[[
  Route aliases database storage
]]f
settings.route_aliases_storage = true

(Optional) Configure the files metadata database storage

Complementary to the use of file module, you can store files metadata into the database.

  1. Run the following SQL queries in strict order:

####SQLite

CREATE TABLE file(
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  user_id UNSIGNED BIG INT, -- User ID of author
  filename VARCHAR(255),
  filepath VARCHAR(255),
  filemime VARCHAR(255),
  filesize UNSIGNED INT(10),
  status boolean,
  timestamp UNSIGNED BIG INT
);
CREATE INDEX idx_file_user ON file (user_id);
CREATE INDEX idx_file_status ON file (status);
CREATE INDEX idx_file_timestamp ON file (timestamp);

####PostgreSQL

CREATE TABLE file(
  id integer NOT NULL,
  user_id bigint, -- User ID of author
  filename character varying(255),
  filepath character varying(255),
  filemime character varying(255),
  filesize bigint,
  status smallint,
  "timestamp" bigint
);
CREATE SEQUENCE file_id_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1;
ALTER SEQUENCE file_id_seq OWNED BY file.id;
ALTER TABLE ONLY file ALTER COLUMN id SET DEFAULT nextval('file_id_seq'::regclass);
ALTER TABLE ONLY file ADD CONSTRAINT file_pkey PRIMARY KEY (id);
CREATE INDEX idx_file_user ON file USING btree (user_id);
CREATE INDEX idx_file_status ON file USING btree (status);
CREATE INDEX idx_file_timestamp ON file USING btree ("timestamp");
  1. Enable database storage for route aliases
--[[
  Files metadata database storage
]]
settings.filedb_storage = true
settings.bytes_per_chunk = 1024 * 1024,

NOTE: Ophal is compatible with SQLite only.

  1. Send feedback

Whether you successfully installed Ophal or not, please file an issue with your feedback at https://github.com/ophal/core/issues/new in order to help us improve the installation instructions and the installer.

-- The Ophal Team