README.md

A getting started guide to self-hosting Econumo CE

---

Prerequisites

• Docker and Docker Compose must be installed on your machine.
• At least 256 MB of RAM is recommended.

Quick start

1. Clone this repository:

   $ git clone --single-branch https://github.com/econumo/econumo-ce econumo
   Cloning into 'econumo'...
   remote: Enumerating objects: 13, done.
   remote: Counting objects: 100% (10/10), done.
   remote: Compressing objects: 100% (9/9), done.
   remote: Total 13 (delta 0), reused 7 (delta 0), pack-reused 3 (from 1)
   Receiving objects: 100% (13/13), done.
   
   $ cd econumo
   
   $ ls -1
   README.md
   docker-compose.yml
   .env.example

2. Create and configure your environment file:

   $ cp .env.example .env

3. Start the services with Docker Compose:

   $ docker-compose up -d

4. Visit your instance at http://localhost:8181 and create the first user.

Note

Please note that it may take up to 90 seconds for the initial run. When you see nginx entered RUNNING state in the logs, it means Econumo is ready.

If you're interested, you can find the Dockerfile and entrypoint.sh script in the repository.

Next steps

After installation, you may need to complete additional configuration. Please refer to the following guides:

• How to configure multi-currency support (Econumo comes preloaded with USD only).
• How to configure backups.
• Useful CLI commands.
• How to debug Econumo.
• Econumo API.
• User Guide.

For more information please see our documentation.

Contact

• For release announcements, please check GitHub Releases or Econumo Website.
• For questions, issue reporting, or advice, please use GitHub Discussions.

---

Note

Econumo CE is funded by our GitHub Sponsors and Econumo (cloud) subscribers.

If you know someone who might find Econumo useful, we'd appreciate if you'd let them know.