1# Installation instructions
2
3## pip
4
5**Note that using pip outside virtualenv is not recommended since it ignores
6your systems package manager. If you aren't comfortable debugging package
7installation issues, this is not the option for you.**
8
9Create and activate a virtualenv:
10
11```bash
12virtualenv artifactsenv
13cd artifactsenv
14source ./bin/activate
15```
16
17Upgrade pip and install Forensics Artifacts dependencies:
18
19```bash
20pip install --upgrade pip
21pip install artifacts
22```
23
24To deactivate the virtualenv run:
25
26```bash
27deactivate
28```
29
30## Ubuntu 18.04 and 20.04 LTS
31
32To install Forensics Artifacts from the [GIFT Personal Package Archive (PPA)](https://launchpad.net/~gift):
33
34```bash
35sudo add-apt-repository ppa:gift/stable
36```
37
38Update and install Forensics Artifacts:
39
40```bash
41sudo apt-get update
42sudo apt-get install python3-artifacts
43```
44
45## Windows
46
47The [l2tbinaries](https://github.com/log2timeline/l2tbinaries) contains the
48necessary packages for running Forensics Artifacts. l2tbinaries provides the following
49branches:
50
51* main; branch intended for the "packaged release" of Forensics Artifacts and dependencies;
52* dev; branch intended for the "development release" of Forensics Artifacts;
53* testing; branch intended for testing newly created packages.
54
55The l2tdevtools project provides [an update script](https://github.com/log2timeline/l2tdevtools/wiki/Update-script)
56to ease the process of keeping the dependencies up to date.
57
58The script requires [pywin32](https://github.com/mhammond/pywin32/releases) and
59[Python WMI](https://pypi.org/project/WMI/).
60
61To install the release versions of the dependencies run:
62
63```
64set PYTHONPATH=.
65
66C:\Python38\python.exe tools\update.py --preset artifacts
67```
68