A big thanks to all the contributors worldwide. This is a global effort with collaboration from these countries:

Welcome aboard! Follow these steps to get started.

Step 1 - Join the discord and introduce yourself to the community join discord

Step 2 - Familiarize yourself with the technical documentation in the companion repo alt-core-docs

Step 3 - Clone this repo and follow steps to build & run alt-core (instructions below)

Step 4 - Check out the backlog open issues. Look for issues marked good first issue. these are good starting points to contribute if you are new to the project. issues

alt-core
│  └─── README.md - this file
│  └─── LICENSE - license file (AGPL v3)
|  └─── build-all.sh - build script
|  └─── build-clean.sh - clean build script
|  └─── clean.sh - data clean script (fresh install)
|  └─── run.sh - launch script
│
└─── cass-server-maven
│   └─── src - source files
│
└───rtserver-maven
│   └─── src - source files
|
└───scrubber-maven
│   └─── src - source files
|
└───rtserver
│   └─── config - config files  
|
└───scrubber 
│   └─── src - source files
│   └─── repo - JAR dependency files
│   └─── config - config files
│   |   │   www-bridge.properties
│   |   │   www-processor.properties
│   |   │   www-rtbackup.properties
│   |   │   www-server.properties
│   |
|   └─── data - data files
│   
└───web
    └─── cass - web app files (angularJS)

• JDK (recommended OpenJDK v17 or later)
• Maven (recommended v3.9.x or later)
• A modern web browser (to run the web app)

run the script build-all.sh in the root project folder

$ cd alt-core
$ ./build-all.sh

run script

$ ./setweb.sh

ths will set root property path in scrubber/config/www-server.properties

full path required - e.g.

root=/Users/ale/Development/GitHub/alt-core/web

$ ./setup.sh

this will create required working directories for data, etc..

$ ./run.sh

open browser and run the setup wizard to set admin password, scan folders, etc...

$ open http://localhost:8081/cass/setup.htm?spage=1

4.1 choose Advanced Setup, click next

4.2 page 1 - Network - set computer name, admin password, remote access, etc. Click next.

4.3 page 2 - Scan Files Folders - set the folders to scan for files for Drive #1. Click next.

4.4 page 3 - Backup & Sync - Specify how many copies of files for backups. Keep default. Click next.

4.5 page 4 - File Types - Specify the file types you wish to scan/index or keep defaults. Click next.

4.6 page 5 - Email configuration - Email indexing settings. Keep defaults. Click next.

open browser and login with your admin credentials

uiv5 (React)

$ open http://localhost:8081/cass/uiv5/dist/i.html

uiv3 (Legacy/Angular)

$ open http://localhost:8081/cass/uiv3/indexv2.htm

note: default login credentials user:admin password:valid

setup wizard (step 4) will allow you to set your own admin password.

After few seconds, files detected in your scan folders (step 4.3) will start to appear.

If you want to enable remote access to your server via DNS-resolvable hostname, you can set up a reverse proxy or tunnel. To set up a Tunnel using Cloudflared, use the following guide here to set up a tunnel.

Distributed under the AGPL v3 License. See LICENSE file for more information.