Skip to content
EN
Log in Sign up
Docs

User guide

Installation

This guide walks you through installing Zittme. There are two main kinds of environments.

  • Web hosting: An environment you use by signing up with a hosting company. The DB and web server are already set up, so you only need to upload the files.
  • Your own server (VPS): An environment where you run the server yourself. You set up the web server and DB yourself.

Follow only the part that matches your environment. From the installation wizard onward, both environments are the same.

Requirements

ItemRequirement
PHP7.4 or later (8.2 or later recommended)
DatabaseMySQL 5.7 or later, or MariaDB 10.6 or later (utf8mb4)
Web servernginx or Apache
Required PHP extensionscurl, gd, iconv or mbstring, json, openssl, PDO_MySQL, SimpleXML, Zend OPcache
Recommended PHP extensionsapcu (performance), exif (automatic image rotation), fileinfo (attachment security checks), intl, zip
PHP settingssession.auto_start=off, memory_limit 128MB or more, upload_max_filesize 10MB or more

Most PHP hosting plans from Korean web hosts (Cafe24, Dothome, Gabia, and others) meet these requirements. If you can choose the PHP version when signing up, pick 8.2 or later. In any case, the environment check step of the installation wizard points out anything that's missing.

Downloading the release (both environments)

Download the latest release from the zitt.me release page. During the current beta period, only members registered as testers can download it.

---

A. Installing on web hosting

A-1. Check your DB information

With web hosting, a DB is created when you sign up. Look up the values below in your hosting control panel (such as "My services") ahead of time. You'll enter them as is in the installation wizard.

  • DB host (usually localhost)
  • DB name
  • DB username
  • DB password (the one you set when signing up)

A-2. Upload the files

Unzip the downloaded release on your own computer first, then upload it to your host's web root with an FTP program (FileZilla, etc.). The name of the web root folder varies by host (www, public_html, html, etc.).

  • There are tens of thousands of files, so FTP uploads take time, and FTP programs sometimes miss some files when uploading thousands of them. If your host offers an unzip feature (web file manager), uploading the tgz/zip and extracting it on the server is faster and safer.
  • After uploading, check that index.php is directly under the web root. If it's one level down, like zittme/index.php, move the folder's contents to the web root. Be sure to move hidden files such as .htaccess as well.
  • Create a files folder in the web root and set its permissions to 707 (or 777) in the file manager. All of the site's uploads and cache are stored in this folder.

A-3. Open the site

Open your domain (or the temporary address your host gave you) in a browser, and the installation wizard starts. Go to the "Installation wizard" section below.

Most web hosting runs Apache, so the .htaccess included in the release handles short URLs automatically. No extra setup is needed.

---

B. Installing on your own server (VPS)

This assumes a server you can access through a shell (SSH).

B-1. Upload the files

tar xzf zittme-0.0.01.tgz -C /var/www/mysite
mkdir -p /var/www/mysite/files
chown -R www-data:www-data /var/www/mysite

The web server account (www-data in the example above) must be able to write to the files folder for installation to proceed. All of the site's uploads, cache, and settings are stored in this folder.

B-2. Create the database

CREATE DATABASE mysite DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'mysite'@'localhost' IDENTIFIED BY '비밀번호';
GRANT ALL PRIVILEGES ON mysite.* TO 'mysite'@'localhost';
FLUSH PRIVILEGES;

B-3. Web server configuration (nginx)

Zittme provides nginx configuration helpers.

  • The environment check screen of the installation wizard: detects your server environment and generates a tailored configuration and the commands to apply it.
  • common/scripts/setup-nginx.sh in the release: a script that applies it in one go.
  • Example configuration: common/manual/server_config/zittme-nginx.conf

With Apache, the .htaccess in the release handles it, so you only need mod_rewrite turned on.

---

Installation wizard (both environments)

Open your site address in a browser, and the installation wizard starts. Follow the step indicator at the top of the screen.

  • Environment check: Automatically checks whether the server meets the requirements. If there's a problem, guidance appears for each item.
  • License agreement: Zittme is free software under the GPL v2.
  • Enter DB information: For web hosting, enter the values you checked in A-1; for your own server, the values you created in B-2.
  • Create the admin account: Set the email and password of the site's top administrator.

When installation finishes, the site opens with the default menus (Home, Board), and the default editor is set to zittEditor.

What to check right after installing

  • Admin access: your-site/admin
  • System settings > Basic settings: Site title, default language, time zone
  • Admin screen settings: Admin menu position (top, left, right), admin logo
  • Check file uploads: Write a post on a board and attach an image. If it fails, check write permissions on the files/ folder. On web hosting, you can set permissions to 707 or 755 in the file manager.

Updates

When a new version notice appears on the admin dashboard, download the new release from the release page and overwrite your files. After overwriting, open the admin screen and any required DB changes are applied automatically. Always back up files/ and the DB before updating.