Skip to content

AssetAtlasTracker/AssetAtlas

Repository files navigation

AssetAtlas

AssetAtlas is a self hosted database with an object-oriented approach to keeping track of your stuff. Currently in early development.

Asset Atlas User Setup

Main setup

  1. Install Docker
  2. Make sure you have Python downloaded
  3. Clone the repository
  4. Run the file named "start.py" in the folder that downloaded from this github page on the previous step.
    • You may need to right click on the file and "Open with > python".
  5. In the start.py launcher:
    • If you are only following the main setup: leave local host selected
    • If you are using the multi-device remote functionality and have followed the optional setup steps: select Tailscale mode
  6. Click "Run Docker Compose"
    • This may take five or so minutes the first time, but will be faster on subsequent composes
    • If the compose action fails right away, docker may not be open/running. Make sure the "docker desktop" application you downloaded earlier is running.
    • Once it finishes, a window will pop up "Service is running" with the IP
  7. In your web browser, go to the localhost or Tailscale URL depending on the mode you chose
    • For tailscale to work, Tailscale must be currently running on the device trying to access AssetAtlas

(Optional) Multi device remote access additional setup

  1. Make a Tailscale account
    • https://login.tailscale.com/login
    • Sign in however you like, but you will need to login once every 90 days to refresh your access key which is used in the software.
    • You will need to download the tailscale software on any device you want to use over the internet, such as a phone (It has an app). You will only need to download it on the host device if you would also like to access it from the host device while using multi-device mode.
  2. Create a Tailscale auth key
  3. Navigate to "Auth keys"
  4. Set your key to reusable and ephemeral
  5. When using the "start.py" launcher, paste your key in the auth key box and click save. You'll only need to do this once.
    • Note: this is an authentication key that is stored in plain text on your host machine. If you already use Tailscale/a Tailnet for other things, they could be accessed by someone who has this key. If you are only using Tailscale for AssetAtlas this doesn't really matter as someone who can see this key already has access to your host computer and could see your database anyway.

About

Main repository for AssetAtlas

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors 10