SimpleAccounts
  • 👋Welcome to SimpleAccounts
  • Overview
    • 💡What we do
    • ✨Key Features
  • Getting Started
    • 🖥️Self-Hosted Service
    • 🛠️Installation Guide
      • Docker
      • Linux OS
      • Mac OS
      • Windows
      • 📝Setting permissions
      • 🧑Inviting Members
    • 🧑‍💻Managed Service
  • Product Guides
    • 💸Income
      • 📝Customer Invoices
        • 🔹Create and send invoices to a customer
        • 🔹Send invoices to a customer
        • 🔹Check the status of an invoice
        • 🔹Edit the payment details on an invoice
        • 🔹Update payment details on an invoice which is already sent (for which no payment has been recorded)
        • 🔹Manually record payment on a customer invoice
        • 🔹Change date on an invoice
        • 🔹Delete an invoice
        • 🔹Sort invoices dating oldest to newest
        • 🔹View paid invoices
      • 🧾Income Receipts
        • 🔹View invoices as receipts
      • 📃Quotations
        • 🔹Create a quotation
        • 🔹Send a quotation to a potential customer
    • 💲Expense
      • 💵Expenses
        • 🔹Manually add Expenses
        • 🔹Send an expense note to the payee
      • 📄Supplier Invoices
        • 🔹Create and send an invoice to a supplier
        • 🔹Send invoices to a supplier
        • 🔹Edit the payment details on a supplier invoice
        • 🔹Delete a supplier invoice
        • 🔹Update payment details for an already sent supplier invoice (with no recorded payment)
        • 🔹Delete paid supplier invoice
      • 🧾Purchase Receipts
        • 🔹View supplier invoices as receipts
    • 🏦Banking
      • 🏦Manage Bank Accounts
        • 🔹Add bank account to SimpleAccounts
        • 🔹Edit or update details of a bank account
        • 🔹Delete a bank account
      • 💱Manage Transactions
        • 🔹Add a transaction
        • 🔹Create new parsing template to import bank statement.
        • 🔹Import a transaction from your computer
        • 🔹Reconcile a transaction
        • 🔹Match transaction with books / Explain a transaction
        • 🔹Unmatch transaction with books /Unexplain a transaction
        • 🔹Match an Invoice with Bank Transaction
        • 🔹Create new parsing template to import bank statement
    • 👨‍💼Accountant
      • ⚖️Opening Balance
        • 🔹View opening balance of all the transactions
        • 🔹Add an opening balance manually
      • 📖Journal
        • 🔹View journals
        • 🔹Manually add a journal entry
    • 📊Reports
      • 🔹View a Financial Report
      • 🔹Export or download a report
      • 🔹Print a Report
      • 🔹View Profit and Loss Report
      • 🔹View a report during a specific date.
    • 💰Master
      • 📋Chart of Accounts
        • 🔹Categorize transactions
        • 🔹Add Chart of Accounts
        • 🔹Edit the type of transaction in chart of accounts
        • 🔹Delete an account from the chart of accounts
      • 👤Contact
        • 🔹Add a customer
        • 🔹Edit the details of a customer
        • 🔹Delete a customer
        • 🔹Add a supplier
        • 🔹Delete a supplier
      • 📦Product
        • 🔹Add a product
        • 🔹Update the VAT details of a product
        • 🔹Change the product category of a product
        • 🔹Delete a product
      • 🗃️Product Category
        • 🔹Create a product category
        • 🔹Edit product category
        • 🔹Change the Code of a Product category
        • 🔹Delete a product category
      • 💼VAT Category
        • 🔹Add a VAT category
        • 🔹Edit VAT category
        • 🔹Delete a VAT category
      • 💱Currency Rate
        • 🔹Add a currency rate conversion to UAE dirham
        • 🔹Add the currency rate from Indian rupee to UAE dirham
        • 🔹Update the exchange rate of a currency
        • 🔹Delete a currency rate
      • 👨‍💼Employee
        • 🔹Add an employee
        • 🔹View, send or download Payslip
    • 📦Inventory
      • 🔹View Inventory
      • 🔹Add product to inventory
      • 🔹View a product’s stock in hand
    • 👥Payroll
      • 📃Payroll Configuration
        • 🔹Add New Employee Designation
        • 🔹Add Company Details
        • 🔹Add an employee for Payroll
      • 🅿️Run Payroll
        • 🔹Create a payroll
        • 🔹Approve a Payroll
        • 🔹Reject a Payroll
        • 🔹Update a rejected payroll
        • 🔹View, send or download Payslip
        • 🔹Void an approved payroll
        • 🔹Get the salary information file of the employees
Powered by GitBook
On this page
  • Prerequisites
  • Git Installation
  • Docker Install
  • Ubuntu and Debian-based Systems:
  • Installing Docker Compose on Ubuntu and Debian-based Systems:
  • CentOS:
  • Installing Docker on CentOS:
  • Installing Docker Compose on CentOS:
  • Other Linux Distributions:
  • Installation:
  • Environment Variables

Was this helpful?

  1. Getting Started
  2. Installation Guide

Linux OS

SimpleAccounts-UAE is a web application for managing accounts. This README provides instructions for installing and running SimpleAccounts-UAE using Docker and Docker Compose.

Prerequisites

Before proceeding with the installation, please make sure you have the following prerequisites installed:

  • Git: Install Git

  • Docker: Install Docker

  • Docker Compose: Install Docker Compose

Git Installation

Installing Git on Linux is a very easy process and depending on the Linux distribution you are using. Here are the steps for some common Linux distributions:

  1. Ubuntu/Debian:

  • Open a terminal (you can use Ctrl+Alt+T).

  • Update the package list:

sudo apt update

Install Git:

sudo apt install git

  1. Fedora:

    • Open a terminal.

    • Update the package list

sudo dnf update

Install Git:

sudo dnf install git

  1. CentOS/RHEL:

    • Open a terminal.

    • Install Git from the EPEL repository:

sudo yum install epel-release
sudo yum install git

  1. Other Distributions:

For other Linux distributions, you can use their respective package manager to install Git. Search for the Git package using the package manager and install it.

Verify Installation:

  • After installation, you can verify Git is correctly installed by opening a terminal and running:

git --version

Docker Install

Here are detailed instructions to install Docker and Docker Compose on different Linux distributions:

Ubuntu and Debian-based Systems:

Installing Docker on Ubuntu and Debian-based Systems:

  1. Open a terminal.

  2. Update the package index:

sudo apt update

  1. Install the necessary packages to allow apt to use a repository over HTTPS:

sudo apt install apt-transport-https ca-certificates curl software-properties-common

  1. Add the official Docker GPG key:

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

  1. Add the Docker repository:

    For Ubuntu:

echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

  1. Update the package index again:

sudo apt update

  1. Install Docker:

sudo apt install docker-ce docker-ce-cli containerd.io

  1. Verify the installation by running docker --version in the terminal. It should display the Docker version number.

Installing Docker Compose on Ubuntu and Debian-based Systems:

  1. Install Docker Compose using curl:

sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

  1. Make the docker-compose binary executable:

sudo chmod +x /usr/local/bin/docker-compose

  1. Verify the installation by running docker-compose --version in the terminal. It should display the Docker Compose version number.

CentOS:

Installing Docker on CentOS:

  1. Open a terminal.

  2. Install the required packages for Docker:

sudo yum install -y yum-utils device-mapper-persistent-data lvm2

  1. Add the Docker repository:

sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo

  1. Install Docker:

sudo yum install -y docker-ce docker-ce-cli containerd.io

  1. Start Docker:

sudo systemctl start docker

  1. Enable Docker to start on boot:

sudo systemctl enable docker

  1. Verify the installation by running docker --version in the terminal. It should display the Docker version number.

Installing Docker Compose on CentOS:

  1. Install Docker Compose using curl:

 sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

  1. Make the docker-compose binary executable:

sudo chmod +x /usr/local/bin/docker-compose

  1. Verify the installation by running `

 docker-compose --version` in the terminal. It should display the Docker Compose version number.

Other Linux Distributions:

For other Linux distributions, the installation steps for Docker and Docker Compose may vary. It's recommended to refer to the official Docker documentation for instructions specific to your distribution:

  • Docker installation: https://docs.docker.com/engine/install/

  • Docker Compose installation: https://docs.docker.com/compose/install/

Make sure to follow the instructions provided for your specific Linux distribution to ensure a successful installation of Docker and Docker Compose.

To verify if Docker and Docker Compose are installed correctly, run the following commands:

docker --version
docker-compose --version

Make sure you see the version numbers for both commands.

Installation:

  1. Open the docker/docker-compose.yml file and review the environment variables defined under the backend service section. These variables control various aspects of the application, including SMTP configuration and database settings. It is recommended to change the default values, especially for sensitive information such as passwords.

git clone https://github.com/SimpleAccounts/SimpleAccounts-UAE.git
cd SimpleAccounts-UAE

  1. Clone the SimpleAccounts-UAE repository:

  2. Start the application using Docker Compose:

docker-compose up -d

This command will download the required Docker images and start the containers in the background.

Access the SimpleAccounts-UAE application by opening your web browser and navigating to http://localhost:80.

Environment Variables

The following environment variables can be configured in the docker/docker-compose.yml file under the backend service section:

  • SIMPLEVAT_SMTP_USER: SMTP username for sending emails.

  • SIMPLEVAT_SMTP_PASS: SMTP password for authentication.

  • SIMPLEVAT_SMTP_HOST: SMTP server hostname.

  • SIMPLEVAT_SMTP_PORT: SMTP server port.

  • SIMPLEVAT_SMTP_AUTH: SMTP authentication method.

  • SIMPLEVAT_SMTP_STARTTLS_ENABLE: Enable STARTTLS for SMTP connection.

  • SIMPLEVAT_RELEASE: Application release version.

  • SIMPLEVAT_HOST: Application host URL.

  • SIMPLEVAT_DB_HOST: Hostname of the PostgreSQL database.

  • SIMPLEVAT_DB: Name of the PostgreSQL database.

  • SIMPLEVAT_DB_USER: PostgreSQL database username.

  • SIMPLEVAT_DB_PASSWORD: PostgreSQL database password.

  • SIMPLEVAT_DB_PORT: PostgreSQL database Port number.

It is recommended to review and update these variables according to your specific configuration.

Note: Please ensure that sensitive information, such as passwords, are stored securely and not committed to version control.

PreviousDocker NextMac OS

Last updated 1 year ago

Was this helpful?

🛠️