Skip to content

Commit 3f36ece

Browse files
committed
updates
1 parent 9d7fc1a commit 3f36ece

File tree

7 files changed

+65
-4
lines changed

7 files changed

+65
-4
lines changed

artemis-docs/docs/Apollo/README.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Introduction
6+
7+
Apollo is an **experimental** cross platform timelining GUI tool to review
8+
artemis data. It is heavily inspired by the
9+
[Timesketch](https://timesketch.org/) project. However, Apollo uses the
10+
[Tauri](https://tauri.app) GUI framework and is _not_ a web app.
11+
12+
Similar to Timesketch, apollo uses [OpenSearch](https://opensearch.org/) to
13+
store and query data.
14+
15+
# How to build
16+
17+
Apollo requires a OpenSearch instance in order to store and query data. Podman
18+
or docker is the easiest way to setup OpenSearch
19+
20+
1. Install Podman or Docker on your system. Podman is recommended
21+
2. You can use the
22+
[setup scripts](https://github.com/puffyCid/artemis/tree/main/apollo) in the
23+
artemis repo to quickly spin up a Podman OpenSearch container
24+
3. Install NodeJS and npm
25+
4. Clone the [artemis](https://github.com/puffyCid/artemis) repo
26+
5. Navigate to apollo directory
27+
6. Setup TailwindCSS: `npm run tailwind`
28+
7. Run `npm run tauri dev` to start a local instance or use
29+
`npm run tauri build` to compile a release binary
30+
31+
# Uploading data
32+
33+
Apollo uses the same timeline format as Timesketch. Timelined data must have the
34+
following fields:
35+
36+
1. Datetime (datetime)
37+
2. Timestamp Description (timestamp_desc)
38+
3. Message (message)
39+
4. Data type (data_type)
40+
41+
Apollo supports timelining JSONL output from artemis. For example, if you
42+
collect and parse Windows Registry data
43+
(`artemis acquire --format jsonl registry --alt-file <path to NTUSER.DAT>`).
44+
45+
Apollo can timeline and upload the data to OpenSearch
46+
47+
# Screenshots
48+
49+
Timeline View ![timeline screen](./images/image1.png "Timeline View")
50+
51+
Timeline Entry Details ![entry view](./images/image2.png "Entry View")
52+
53+
Timeline Additional Details
54+
![entry additional view](./images/image3.png "Entry Additional Details")
798 KB
Loading
911 KB
Loading
1.21 MB
Loading

artemis-docs/docs/Intro/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ sidebar_position: 1
44

55
# Introduction
66

7-
**Artemis** is a powerful command line digital forensic and incident response
8-
(DFIR) tool that collects forensic data from Windows, macOS, and Linux
9-
endpoints. Its primary focus is: speed, ease of use, and low resource usage.
7+
Artemis is a powerful command line digital forensic and incident response (DFIR)
8+
tool that collects forensic data from Windows, macOS, and Linux endpoints. Its
9+
primary focus is: speed, ease of use, and low resource usage.
1010

1111
Notable features _so far_:
1212

1313
- Setup collections using basic TOML files
14-
- Parsing support for large amount of forensic artifacts (25+)
14+
- Parsing support for large amount of forensic artifacts (40+)
1515
- Output to JSON or JSONL or CSV file(s)
1616
- Can output results to local system or upload to cloud services.
1717
- Embedded JavaScript runtime via [Deno](https://deno.land/)

artemis-docs/docusaurus.config.js

+6
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ const config = {
9696
position: "left",
9797
label: "Contributing",
9898
},
99+
{
100+
type: "docSidebar",
101+
sidebarId: "apollo",
102+
position: "left",
103+
label: "Apollo",
104+
},
99105
{
100106
href: "https://github.com/puffyCid/artemis",
101107
label: "GitHub",

artemis-docs/sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ const sidebars = {
1818
artemisAPI: [{ type: "autogenerated", dirName: "API" }],
1919
artemisStart: [{ type: "autogenerated", dirName: "Intro" }],
2020
artemisContributing: [{ type: "autogenerated", dirName: "Contributing" }],
21+
apollo: [{ type: "autogenerated", dirName: "Apollo" }],
2122
};
2223

2324
module.exports = sidebars;

0 commit comments

Comments
 (0)