AutoMate

AutoMate Project

Overview

AutoMate is a one-person IT automation project designed to streamline and automate administrative tasks. This project aims to minimize manual work for tasks such as document processing, task management, billing, and reporting through open-source, on-premise tools.

Project Structure

• docs/: Documentation for setup, usage, and maintenance.
• src/: Main codebase, including Docker configuration and automation scripts.
  • src/docker/: Docker Compose configuration files and individual Dockerfile(s).
  • src/scripts/: Custom scripts (e.g., for installation or automation).
  • src/configs/: Configuration files for different services.
• data/: Persistent data storage (e.g., databases).
• logs/: Application logs.

Environment Variables

Create a .env file in the project root with the following placeholders (to be replaced with actual values):

'''bash

Paperless-ngx Configuration

PAPERLESS_DB_USER=myuser PAPERLESS_DB_PASSWORD=randomGeneratedPassword PAPERLESS_SECRET_KEY=randomGeneratedSecret

Nextcloud Configuration

NEXTCLOUD_ADMIN_USER=admin NEXTCLOUD_ADMIN_PASSWORD=randomGeneratedPassword

Database Configuration for Nextcloud

MYSQL_ROOT_PASSWORD=randomGeneratedPassword MYSQL_DATABASE=nextcloud MYSQL_USER=nextcloud MYSQL_PASSWORD=randomGeneratedPassword

Kimai Database Configuration

KIMAI_DATABASE=kimai KIMAI_USER=kimai_user KIMAI_PASSWORD=randomGeneratedPassword KIMAI_ROOT_PASSWORD=randomGeneratedPassword

Kimai Admin User Configuration

KIMAI_ADMIN_USER=kiami_admin_user
KIMAI_ADMIN_PASSWORD=randomGeneratedPassword KIMAI_ADMIN_EMAIL=kiami@admin.email '''

Installation

Step 1: Install Docker

To install Docker on a new system, you can use the provided installation script. Run the following commands in the src/scripts directory:

'''bash cd ~/AutoMate/src/scripts ./install_docker.sh '''

This script will install Docker and add the current user to the Docker group. Note: You will need to log out and log back in for the group permissions to take effect.

Step 2: Docker Compose Setup

1. Navigate to the Docker Config Directory:

'''bash cd ~/AutoMate/src/docker '''

1. Start Docker Compose:

Use Docker Compose to start all configured services.

'''bash docker-compose up -d '''

1. Check Status:

To confirm that all services are running, use:

'''bash docker-compose ps '''

Creating an Admin User for Paperless-ngx

After starting the Paperless-ngx service for the first time, you need to create a superuser (admin) account to access the interface. Follow these steps:

1. Run the following command in your project directory to enter the Paperless-ngx container:

$$$ docker-compose exec paperless python3 manage.py createsuperuser $$$

1. Provide the Required Information:

   • Enter a username for the admin account.
   • Provide an email address.
   • Set a password.

2. Log In to Paperless-ngx:

   • Open your web browser and go to http://localhost:8000.
   • Use the username and password you just created to log in as the admin.

This setup step is necessary only for the first-time setup or if you need to create additional admin users.

Setting Up Kimai (Time Tracking)

After configuring the environment variables, you can start Kimai for time tracking and management.

1. Start Kimai:

   • Run the following command to start the Kimai service along with its database:

   $$$ docker-compose up -d $$$

2. Access Kimai:

   • Open your web browser and go to http://localhost:8081.
   • Log in with the KIMAI_ADMIN_USER and KIMAI_ADMIN_PASSWORD values you set in .env.

3. Using Kimai:

   • After logging in, you can set up projects, track time, and generate reports for your tasks. Kimai provides a comprehensive interface for managing billable time and clients.

This setup provides you with a time tracking tool that can work alongside Paperless-ngx and Nextcloud in the AutoMate system.