Skip to content

Latest commit

 

History

History
89 lines (72 loc) · 2.3 KB

readme.md

File metadata and controls

89 lines (72 loc) · 2.3 KB
Raw

Firespace

(Work)Spaces / User-Profiles for firejail

Why?

Was tired of allways typing the mostly same, but slightly diffrent firejail commands with options not covert by local profiles.

Features

  • Define usage context like "normal", "private", "school", "work"
  • Specify firejail arguments and program arguments to be apply depending on the selected context and/or program you run
  • Config validation
  • Dry run

Usage

Example config

config.yaml (use firespace --help to see the default location)

spaces:
  working:
    home: "/some/path/working"

  private:
    home: ""
    allow_empty_home: true
    env:
      PROXY: "socks5://..."

  nospace:
    home: ""
    allow_empty_home: true
    no_private: true

programms:
  firefox:
    flags:
      - "--no-remote"
      - "https://duckduckgo.com/?q=firejail"
    spaces:
      private:
        overwrites:
          flags: true
        flags:
          - "--no-remote"
          - "--private-window"
          - "https://duckduckgo.com/?q=firejail"

Cli usage

firespace working firefox
will be executed as
=> /usr/bin/firejail --private=/some/path/working firefox --no-remote https://duckduckgo.com/?q=firejail

firespace private firefox
will be executed as
=> /usr/bin/firejail --private firefox --no-remote --private-window https://duckduckgo.com/?q=firejail

firespace nospace firefox
will be executed as => /usr/bin/firejail firefox --no-remote https://duckduckgo.com/?q=firejail

Installation

go install github.com/scaxyz/firespace/cli/firespace@latest

Templating

TODO: improve readme

  • using golang's text/template
  • see TemplateContext
  • e. g. 
    global:
  env:
    _proxy_host: "some-server.mullvad.net"
    _proxy_port: "1080"
    PROXY: "socks5://{{.Space.Env._proxy_host}}:{{.Space.Env._proxy_port}}"
    HTTP_PROXY: "socks5://{{.Space.Env._proxy_host}}:{{.Space.Env._proxy_port}}"
    HTTP_PROXY: "socks5://{{.Space.Env._proxy_host}}:{{.Space.Env._proxy_port}}"

Development

git clone https://github.com/scaxyz/firespace
cd firespace
make install_hook # installed hook will run go tests before commiting #TODO maybe replace with github workflow

Config