Skip to content

Latest commit

 

History

History
executable file
·
213 lines (166 loc) · 6.31 KB

README.md

File metadata and controls

executable file
·
213 lines (166 loc) · 6.31 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Osiris Password Manager

A simple and lightweight encrypted password manager written in Go.

Report Bug || Request Feature

Table of Contents

About The Project


You don't have to remember your passwords anymore with Osiris!

example

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • linux or windows (available for macOS only with Docker)

Installation

Debian and Ubuntu-based

# go to Releases and download the deb package
# install the deb package
sudo apt install ./Osiris-pwm1.0.deb

Any other Linux distribution

# select where to download the program, for example here I download it to the Desktop
cd Desktop
# clone and go into repo
git clone https://github.com/liamtoaldo/Osiris-pwm.git
cd Osiris-pwm/
# change mod
chmod +x Osiris-pwm
# run
./Osiris-pwm

Any other Linux distribution (Releases method)

# go to Releases and download the .zip file
# decompress it
unzip -q Osiris-pwm1.0.zip
# go into the directory
cd Osiris-pwm
# change mod
chmod +x Osiris-pwm
# run
./Osiris-pwm

Any other Linux distribution (Build from source)

For this method you need to have Go installed, build-essential and a few dependencies (even tho they should be downloaded automatically)
If you encounter any problems in installing dependencies, follow this guide: https://github.com/go-gl/glfw

# clone and go into repo
git clone https://github.com/liamtoaldo/Osiris-pwm.git
cd Osiris-pwm/
# remove the linux executable
rm Osiris-pwm
# build
go build
# run
./Osiris-pwm

Windows

Go to Releases and download the setup for Windows (.exe file)
Follow the simple steps
IF THE PROGRAM DOESN'T WORK, RIGHT CLICK ON IT, GO TO PROPERTIES, GO TO COMPATIBILITY AND SELECT "ALWAYS EXECUTE AS ADMINISTRATOR"

Usage

If you followed the previous steps, you just have to run the program. To add a new element to the grid click the white add button on the middle left. To delete an element, edit it so that all its entries are empty, then head to the Edit menu and click "Delete empties" To change theme go to File -> Settings

Developing

Building

Build Script

A build script is provided for easy building. Docker is the only dependency.

Using Docker has the following benefits:

  • Build Linux packages on Mac and Windows
  • Builds are consistent, always built the same way
  • Does not require the build chain to be installed on your workstation
build/docker/build.sh

Built artifacts will be in build/artifacts/ when the build is complete

ls build/artifacts

Osiris-pwm  
Osiris-pwm_linux_amd64.zip  
Osiris-pwm.SHA256SUMS

Local build tools

If Docker is not an option, or you prefer to build in your own environment, you will need the following installed:

  • Go toolchain
  • A C compiler (GCC), this project uses CGO
    • Debian: build-essential
    • Fedora: @development-tools
  • This project uses go-gl, which has its own build requirements

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Me - [email protected]

Project Link: https://github.com/liamtoaldo/Osiris-pwm

Acknowledgements