Installation

Getting Akaunting up and running on your local or remote server takes a few minutes.

The guide below will walk you through the process. The installation is a very simple process and takes less than five minutes to complete.

• Basic instructions
• Detailed instructions
  • Download and Extract
  • Database
  • Env
  • Run the Install wizard
• Setup configuration file
  • Launching the installer
  • Selecting your language
  • Setting up your database
  • Adding an admin
  • Login
  • Support
• NPM Install Error (Macbook)

Basic Instructions

Here’s a brief version of the instructions for those who are already familiar with performing such installations.

1. Visit https://akaunting.com/download to download the Akaunting package.
2. Unzip the downloaded package.
3. Create a database for Akaunting on your web server and a MySQL (or MariaDB) user with full privileges to access and modify it.
4. (Optional) Rename .env.example to .env and edit the file (see Editing .env) to add your database information. Note: If you are not comfortable renaming files, you can skip this step, as the installation program will create the .env file for you.
5. Upload the Akaunting files to the desired location on your web server:
   • If you want to integrate Akaunting into the root of your domain (e.g., https://example.com/) Move or upload all the contents of the unzipped Akaunting directory (excluding the Akaunting directory itself) into the root directory of your web server.
   • If you want to have your Akaunting installation in its own subdirectory on your website (e.g., https://example.com/akaunting/), create a directory named akaunting on your server, and upload the contents of the unzipped Akaunting package to that directory via FTP. Note: If your FTP client has an option to convert file names to lowercase, make sure it’s disabled.
6. Run the Akaunting installation script by accessing the URL in a web browser. This should be the URL where you uploaded the Akaunting files:
   • If you installed Akaunting in the root directory, visit: https://example.com/
   • If you installed Akaunting in its own subdirectory, for example akaunting, visit: https://example.com/akaunting/
7. That’s it! Akaunting should now be installed.

Detailed instructions

Step 1: Download and Extract

Download and unzip the Akaunting from https://akaunting.com/download.

Step 2: Database

• If you only have one database and it is already in use, you can install Akaunting in that database. Akaunting uses a distinct prefix for each installation to avoid overwriting existing database tables.
• To create a new database, follow the instructions below for using phpMyAdmin.
• Create a new database:
  • On the phpMyAdmin home page, click on the “Databases” tab in the left-hand panel.

• • Enter a name for your new database in the “Database name” field. Your database name should be short and meaningful, e.g., akaunting or my_new_database. Select a “Collation” from the drop-down menu. Collation defines the character set your database will support. Generally, “utf8mb4_general_ci” or “utf8_general_ci” are good choices.
  • Click the “Create” button to create your database.

Step 3: Env

• You can either create and edit the .env file yourself, or you can skip this step and let Akaunting attempt to create and configure it automatically when you run the installation script (Step 4). (You will still need to provide Akaunting with your database information.)
• Return to where you extracted the Akaunting in Step 1, rename the file .env.example to .env, and open it in a text editor.
  • APP_URL: The base URL of the application used to generate URLs and links.
  • APP_KEY: A random, secret key used for encrypting data and securing the application.
  • DB_CONNECTION: Specifies the type of database connection (e.g., mysql, pgsql).
  • DB_HOST: The IP address or hostname of the database server.
  • DB_PORT: The port number for connecting to the database server (e.g., 3306, 5432).
  • DB_DATABASE: The name of the database to be used.
  • DB_USERNAME: The username for connecting to the database.
  • DB_PASSWORD: The password for the database user account.
  • DB_PREFIX: A prefix to be added to database table names to prevent name collisions between multiple applications.

Note: When you manually update the .env information, there must be a previous Akaunting installation in the database. Otherwise, your installation will not work.

Step 4: Run the Install wizard

Point a web browser to start the installation script.

• If you placed the Akaunting files in the root directory, you should visit: https://example.com
• If you placed the Akaunting files in a subdirectory called blog, for example, you should visit: https://example.com/akaunting/

Setup configuration file

If you have manually created the .env file, you will be redirected directly to the login page, bypassing the installation page.

Launching the Installer

Enter http://your-domain/akaunting-directory in your browser.

This will launch the installation wizard. The installation wizard takes you through the following steps.

• Select your language
• Set up your database.
• Add an admin
• Login

Selecting Your Language

Select your preferred language.

Akaunting is available in 50+ languages.

Setting up your database

Add the database connection details – Hostname, Username, Password, and Database Name.

Adding an Admin

You can add the Company Name & E-mail and create a new Administration account.

Login

After installing, you can log into the admin panel with your account details.

Check out How to get your API key and Set up your Company

Support

You can contact us for Dedicated Support if there are any installation issues.

NPM Install Error

While installing Akaunting on your MacBook (Apple Silicon), you may experience an NPM Install Error. Here’s a reference on how to resolve the error.