mirror of
https://github.com/overcuriousity/autopsy-flatpak.git
synced 2025-07-06 21:00:22 +00:00
readme updates
This commit is contained in:
parent
8ca5a5db80
commit
948f7d385b
16
homebrew/README.md
Normal file
16
homebrew/README.md
Normal file
@ -0,0 +1,16 @@
|
||||
## Installing from Homebrew
|
||||
|
||||
Autopsy can be installed from homebrew by running brew with [`autopsy4.rb`](./autopsy4.rb) in this directory. Before you run the command, you may want to remove any previous versions of Autopsy and The Sleuth Kit, especially if they are installed `/usr/local/` as homebrew installs binaries and libraries in the same directory, which may cause conflicts. So the full path would be something like: `brew install --debug --build-from-source --verbose ./autopsy4.rb` when executing from this directory. After that point, you should be able to run autopsy from the command line by calling `autopsy`.
|
||||
|
||||
## Updating Versions for Homebrew
|
||||
|
||||
The version of Autopsy in the homebrew script can be updated by calling [`version_update.py`](./version_update/version_update.py) with a command like `python version_update.py -s https://path/to/sleuthkit-version.tar.gz -a https://path/to/autopsy-version.zip`. You will likely need to install the python dependencies in the [requirements.txt](./version_update/requirements.txt) with a command like: `pip install -r requirements.txt`.
|
||||
|
||||
The version of Autopsy can be updated manually by modifying the following variables in [`autopsy4.rb`](./autopsy4.rb):
|
||||
- `AUTOPSY_RESOURCE_URL`: the location of the autopsy platform zip like `https://github.com/sleuthkit/autopsy/releases/download/autopsy-4.19.2/autopsy-4.19.2.zip`
|
||||
- `AUTOPSY_RESOURCE_SHA256`: the SHA-256 of the autopsy platform zip. This can be calculated by running `curl <url> | sha256sum`
|
||||
- `TSK_RESOURCE_URL`: the location of the sleuthkit compressed files like `https://github.com/sleuthkit/sleuthkit/releases/download/sleuthkit-4.11.1/sleuthkit-4.11.1.tar.gz`
|
||||
- `TSK_RESOURCE_SHA256`: the SHA-256 of the sleuthkit compressed files.
|
||||
|
||||
|
||||
*There is more information in Jira 8425.*
|
15
snap/README.md
Normal file
15
snap/README.md
Normal file
@ -0,0 +1,15 @@
|
||||
## Installing Snap
|
||||
|
||||
An Autopsy [snap package](https://snapcraft.io/) file can be installed by running `sudo snap install autopsy.snap --classic --dangerous`. The `--classic` flag gives the snap package access to necessary system resources (see [confinement](https://snapcraft.io/docs/snap-confinement) for more information) and `--dangerous` needs to be specified because the snap package isn't signed (see [install modes](https://snapcraft.io/docs/install-modes#heading--dangerous) for more information).
|
||||
|
||||
## Generating The Snap Package
|
||||
|
||||
A [snap package](https://snapcraft.io/) of Autopsy can be generated using the [`snapcraft.yml`](./snapcraft.yaml) file. You will need [snapcraft](https://snapcraft.io/) on your system and [lxd](https://snapcraft.io/lxd) works well for virtualization while building the snap package. Since snapcraft needs virtualization to create the snap package, your computer's hardware will need to support virtualization and any relevant settings will need to be enabled. From testing as of November 2022, VirtualBox and WSL are not good build environments. Once the development environment has been set up, a snap package can be built with this command: `snapcraft --use-lxd --debug` run from this directory.
|
||||
|
||||
## Updating Versions for Snap
|
||||
|
||||
The version of Autopsy in the [`snapcraft.yml`](./snapcraft.yaml) can be updated by calling [`version_update.py`](./version_update/version_update.py) with a command like `python version_update.py -s sleuthkit_release_tag -a autopsy_release_tag -v snapcraft_version_name`. You will likely need to install the python dependencies in the [requirements.txt](./version_update/requirements.txt) with a command like: `pip install -r requirements.txt`.
|
||||
|
||||
The version of Autopsy can be updated manually by modifying fields relating to git repositories and commits in [`snapcraft.yml`](./snapcraft.yaml) under `parts.autopsy` and `parts.sleuthkit`. Specifically `source`, `source-branch`, and `source-tag`. More information can be found [here](https://snapcraft.io/docs/snapcraft-yaml-reference).
|
||||
|
||||
*There is more information in Jira 8425.*
|
Loading…
x
Reference in New Issue
Block a user