Skip to content

getting-started.md

Latest commit

 

History

History
42 lines (31 loc) · 1.29 KB

getting-started.md

File metadata and controls

42 lines (31 loc) · 1.29 KB
Raw
id getting-started
title Getting Started

Getting Started

NeoArchive is a self-hosted document management app that automatically recognizes, summarizes, tags, and makes your documents searchable - all under your own control.

Installation

npm install -g neoarchive
neoarchive install
neoarchive setup
neoarchive start

neoarchive install creates the data directory under ~/.neoarchive, installs dependencies, and initializes the database. neoarchive setup walks you interactively through port, admin credentials, encryption, and optional AI configuration.

First sign-in

Once started, the web interface is available at the configured address (default: http://localhost:4400). Register your first user account there, or sign in at /admin with the administrator credentials you set during setup.

Upload your first document

  1. Open Documents and click Upload.
  2. Choose a PDF, image, or text file.
  3. NeoArchive automatically recognizes document type, sender, summary, and relevant dates.
  4. Any recognized value can be corrected manually at any time - a manual edit is never overwritten by a later automatic analysis.

Next steps