github.com/StackExchange/blackbox/v2@v2.0.1-0.20220331193400-d84e904973ab/docs/compatibility.md (about)

     1  Compatibility
     2  =============
     3  
     4  # Compatibility with Blackbox v1
     5  
     6  The command names all changed from v1 to v2.  The `binv2` directory
     7  includes shell scripts that provide full backwards compatibility.
     8  
     9  # Supported Architectures
    10  
    11  Blackbox supports a plug-in archtecture to easily support multiple VCS
    12  system.  Current support is for:
    13  
    14  ## Supported VCS/DVCS systems
    15  
    16  * git
    17  * "none" (repo-less use is supported)
    18  * WOULD LOVE VOLUNTEERS TO HELP ADD SUPPORT FOR: hg, svn, p4
    19  
    20  ## Supported GPG versions
    21  
    22  * Git 1.x and 2.0
    23  * Git 2.2 and higher
    24  * WOULD LOVE VOLUNTEERS TO HELP ADD SUPPORT FOR:
    25    golang.org/x/crypto/openpgp (this would make the code have no
    26    external dependencies)
    27  
    28  ## Supported Operating systems
    29  
    30  Blackbox should work on any Linux system with GnuPG installed.
    31  Blackbox simply looks for `gpg` in `$PATH`.
    32  
    33  Windows: It should work (but has not been extensively tested) on
    34  Windows WSL2.
    35  
    36  # Automated testing
    37  
    38  While many combinations work, we do automated tests
    39  on these combinations.  If any of these fail it blocks the release:
    40  
    41  * macOS: GnuPG 2.2 executables from https://gpgtools.org/
    42  * CentOS: GnuPG 2.0.x executables from the "base" or "updates" repo.
    43  
    44  Windows native: VOLUNTEER NEEDED to make a native Windows version
    45  (should be rather simple as Go does most of the work)
    46  
    47  NOTE: Version 1 worked on CentOS/RedHat, macOS, Gygwin, WinGW, NetBSD,
    48  and SmartOS.  Hopefully we can achieve that broad level of support in
    49  the future.  Any system that is supported by the Go language and
    50  has GuPG 2.0.x or higher binaries available should be easy to achieve.
    51  We'd also like to have automated testing for the same.
    52  
    53  # Windows Support
    54  
    55  BlackBox assumes that `blackbox-admins.txt` and `blackbox-files.txt` will have
    56  LF line endings. Windows users should be careful to configure Git or other systems
    57  to not convert or "fix" those files.
    58  
    59  If you use Git, add the following lines to your `.gitattributes` file:
    60  
    61      **/blackbox-admins.txt text eol=lf
    62      **/blackbox-files.txt text eol=lf
    63  
    64  The `blackbox init` (and newer versions of `blackbox_initialize`)
    65  will create an appropriate `.gitattributes` file for you.
    66  
    67  # Cygwin
    68  
    69  TODO: List what packages are required for building the software.
    70  
    71  TODO: List what packages are required for running the software.
    72  
    73  
    74  # MinGW
    75  
    76  MinGW (comes with Git for Windows) support requires the following:
    77  
    78  TODO: FILL IN any requirements