Merge branch 'upstream-edit'
Rename macOS build page. Rename Flatpak build page. Update Home.md Add LICENSE file. Add Troubleshooting file.
Dom Rodriguez
commit
a090af1559
|
|
@ -0,0 +1,80 @@
|
|||
# Overview
|
||||
|
||||
## Before You Start
|
||||
|
||||
You should be at least moderately comfortable with Git, CMake, and the command
|
||||
line before relying on this method. It requires a good bit of free hard drive
|
||||
space due to the large amount of dependencies required for the build (see below)
|
||||
and is meant for programmers that want to help discover and fix programming
|
||||
errors. When in doubt go for [binaries](Home) instead!
|
||||
|
||||
# How to Build Barrier.app on MacOS
|
||||
|
||||
*as of May 2020*
|
||||
|
||||
- Install Xcode from the App Store or download and install it
|
||||
from the [Apple Developer Website](https://developer.apple.com/download/more/?=xcode)
|
||||
- Install either [MacPorts](https://www.macports.org/) or [Homebrew](https://brew.sh/)
|
||||
following the instructions on their websites
|
||||
- Install dependencies with either MacPorts or Homebrew (see below)
|
||||
- Build either the `Debug` or the `Release` targets (see below)
|
||||
|
||||
### Install dependencies with MacPorts
|
||||
|
||||
- Install packages for Qt5, OpenSSL, and PkgConfig
|
||||
```
|
||||
sudo port install qt5 openssl pkgconfig
|
||||
```
|
||||
|
||||
### Install dependencies with Homebrew
|
||||
|
||||
- Install packages for Qt5, OpenSSL, and pkgconfig
|
||||
```
|
||||
brew install qt5 openssl pkg-config
|
||||
```
|
||||
|
||||
### Clone the repository
|
||||
|
||||
```
|
||||
git clone https://github.com/debauchee/barrier
|
||||
```
|
||||
- Change directories into the cloned repository
|
||||
```
|
||||
cd barrier
|
||||
```
|
||||
|
||||
### Build the Debug target
|
||||
*The debug target produces un-stripped binaries that have symbols that can be
|
||||
used for debugging.*
|
||||
|
||||
- Build the `Debug` target using the `clean_build.sh` script
|
||||
```
|
||||
./clean_build.sh
|
||||
```
|
||||
|
||||
By default the resulting binaries will be in `./build/bin` and the
|
||||
application bundle (.app) will be in `./build/bundle`. The debug target
|
||||
does not create a disk image (dmg).
|
||||
|
||||
### Build the Release target
|
||||
*The release target produces smaller stripped binaries and distributable disk image.
|
||||
This is probably what you want if you are a user.*
|
||||
|
||||
- Build the `Release` target using the `clean_build.sh` script with environment variables
|
||||
|
||||
*This step assumes the use of a bourne-like shell (i.e. bash). If using another shell like*
|
||||
`csh` *change the export command to use* `setenv` *instead*.
|
||||
```
|
||||
export B_BUILD_TYPE=Release
|
||||
./clean_build.sh
|
||||
```
|
||||
|
||||
By default the resulting binaries will be in `./build/bin` and the
|
||||
application bundle (.app) will be in `./build/bundle`. The release target
|
||||
also creates a disk image (dmg).
|
||||
|
||||
#### Notes
|
||||
|
||||
A [`build_env.sh`](https://github.com/debauchee/barrier/blob/b6a1b5742006157c3fe746288961a9d2827a3f26/clean_build.sh#L20)
|
||||
file can be created for persistent build environment variables [without being tracked by git](https://github.com/debauchee/barrier/blob/b6a1b5742006157c3fe746288961a9d2827a3f26/.gitignore#L1)
|
||||
|
||||
21
Home.md
21
Home.md
|
|
@ -2,12 +2,27 @@
|
|||
|
||||
## General
|
||||
|
||||
There is quite a bit to be added to our wiki here on GitHub. As time permits and as the project progresses we will be adding bits of information to the wiki. For now we wanted to share our binary downloads for stable builds. Stay tuned for more!
|
||||
### Distro-Specific Pacakges
|
||||
There is quite a bit to be added to our wiki here on GitHub. As time permits and
|
||||
as the project progresses we will be adding bits of information to the wiki. For
|
||||
now we wanted to share our binary downloads for stable builds. Stay tuned for
|
||||
more!
|
||||
|
||||
*Current Version:*: 2.3.2
|
||||
|
||||
[](https://repology.org/project/barrier/versions)
|
||||
|
||||
## Binary Downloads
|
||||
|
||||
[Binary downloads can be found here](https://github.com/debauchee/barrier/releases/tag/v2.3.1)
|
||||
[Windows](https://github.com/debauchee/barrier/releases/download/v2.3.2/BarrierSetup-2.3.2.exe)
|
||||
* The installer will automatically download and install the VC++ Runtime if
|
||||
necessary.
|
||||
|
||||
[macOS](https://github.com/debauchee/barrier/releases/download/v2.3.2/Barrier-2.3.2-Release.dmg)
|
||||
|
||||
FreeBSD - no builds available as of yet.
|
||||
|
||||
Linux - no builds available as of yet, RPM, DEB packages on the roadmap.
|
||||
|
||||
### Distro-Specific Linux Packages
|
||||
|
||||
[ArchLinux AUR](https://aur.archlinux.org/packages/barrier/) (maintainer: [Tblue](https://github.com/Tblue))
|
||||
|
|
|
|||
|
|
@ -0,0 +1,438 @@
|
|||
Attribution-NonCommercial-ShareAlike 4.0 International
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
|
||||
Public License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution-NonCommercial-ShareAlike 4.0 International Public License
|
||||
("Public License"). To the extent this Public License may be
|
||||
interpreted as a contract, You are granted the Licensed Rights in
|
||||
consideration of Your acceptance of these terms and conditions, and the
|
||||
Licensor grants You such rights in consideration of benefits the
|
||||
Licensor receives from making the Licensed Material available under
|
||||
these terms and conditions.
|
||||
|
||||
|
||||
Section 1 -- Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. BY-NC-SA Compatible License means a license listed at
|
||||
creativecommons.org/compatiblelicenses, approved by Creative
|
||||
Commons as essentially the equivalent of this Public License.
|
||||
|
||||
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
|
||||
e. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
g. License Elements means the license attributes listed in the name
|
||||
of a Creative Commons Public License. The License Elements of this
|
||||
Public License are Attribution, NonCommercial, and ShareAlike.
|
||||
|
||||
h. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
i. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
k. NonCommercial means not primarily intended for or directed towards
|
||||
commercial advantage or monetary compensation. For purposes of
|
||||
this Public License, the exchange of the Licensed Material for
|
||||
other material subject to Copyright and Similar Rights by digital
|
||||
file-sharing or similar means is NonCommercial provided there is
|
||||
no payment of monetary compensation in connection with the
|
||||
exchange.
|
||||
|
||||
l. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
m. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
n. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
|
||||
Section 2 -- Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part, for NonCommercial purposes only; and
|
||||
|
||||
b. produce, reproduce, and Share Adapted Material for
|
||||
NonCommercial purposes only.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. Additional offer from the Licensor -- Adapted Material.
|
||||
Every recipient of Adapted Material from You
|
||||
automatically receives an offer from the Licensor to
|
||||
exercise the Licensed Rights in the Adapted Material
|
||||
under the conditions of the Adapter's License You apply.
|
||||
|
||||
c. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties, including when
|
||||
the Licensed Material is used other than for NonCommercial
|
||||
purposes.
|
||||
|
||||
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
b. ShareAlike.
|
||||
|
||||
In addition to the conditions in Section 3(a), if You Share
|
||||
Adapted Material You produce, the following conditions also apply.
|
||||
|
||||
1. The Adapter's License You apply must be a Creative Commons
|
||||
license with the same License Elements, this version or
|
||||
later, or a BY-NC-SA Compatible License.
|
||||
|
||||
2. You must include the text of, or the URI or hyperlink to, the
|
||||
Adapter's License You apply. You may satisfy this condition
|
||||
in any reasonable manner based on the medium, means, and
|
||||
context in which You Share Adapted Material.
|
||||
|
||||
3. You may not offer or impose any additional or different terms
|
||||
or conditions on, or apply any Effective Technological
|
||||
Measures to, Adapted Material that restrict exercise of the
|
||||
rights granted under the Adapter's License You apply.
|
||||
|
||||
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database for NonCommercial purposes
|
||||
only;
|
||||
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material,
|
||||
including for purposes of Section 3(b); and
|
||||
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
||||
|
|
@ -0,0 +1,205 @@
|
|||
<a name="top"></a>
|
||||
|
||||
# Barrier Troubleshooting Steps
|
||||
|
||||
This guide has steps that can be tried for troubleshooting Barrier. These steps can help isolate the issue and recommend things to try to resolve the issue. Specific steps for making configuration changes outside of Barrier (i.e. Network, Firewall, Permissions, etc...) are outside the scope of this document and the appropriate references should be used.
|
||||
|
||||
## Document Conventions
|
||||
|
||||
- Text in angle brackets `<text>` is input supplied by the user
|
||||
- Text in _italics_ are user interface elements, items on-screen, or filenames
|
||||
- Text in a `monospaced font` are keyboard shortcuts, prompts, commands, or command output
|
||||
|
||||
## Things to Check
|
||||
|
||||
|
||||
- [The Command Line](#command_line)
|
||||
- [Processes Running](#processes_running)
|
||||
- [Server Reachability](#server_reachability)
|
||||
- [Server Listening](#server_listening)
|
||||
- [Multiple Instances](#multiple_instances)
|
||||
- [Fingerprint Trust](#fingerprint_trust)
|
||||
|
||||
|
||||
## <a name="command_line">Command Line</a>
|
||||
Most of the tools used to troubleshoot in this guide are run from a text-based command line. These are some possible steps to get to the command line interface.
|
||||
|
||||
__Note:__ None of the below commands should require elevated access (`Administrator cmd.exe`, `sudo`, `su`, `doas`, or equivalent) unless specified.
|
||||
|
||||
### Windows Command Prompt
|
||||
1. Press the `(⊞ Win) + R` to open the _Run_ dialog
|
||||
2. In the _Open:_ textbox, type `cmd` and click _OK_
|
||||
|
||||
### Windows PowerShell
|
||||
1. Press the `(⊞ Win) + R` to open the _Run_ dialog
|
||||
2. In the _Open:_ textbox, type `powershell` and click _OK_
|
||||
|
||||
### MacOS Terminal.app
|
||||
1. Press `(⌘ Cmd) + Space` to open _Spotlight_ search
|
||||
2. Type `Terminal.app` and press `Enter`
|
||||
|
||||
### Linux Virtual Terminal
|
||||
There are many ways to open a terminal emulator in the GUI on various linux distributions. If you do not know how to access a terminal emulator (`xterm`, `konsole`, `gnome-terminal`, etc...) the steps for accessing the console are fairly standard. Press `Ctrl + Alt` and one of the Function keys (usually `F1` through `F7`) to switch between back and forth between the GUI and virtual terminals.
|
||||
|
||||
[Back to Top](#top)
|
||||
|
||||
## <a name="processes_running">Processes Running</a>
|
||||
Barrier uses multiple process to create the software KVM effect. If using the GUI, check that GUI icon is in the _system tray_ (Windows or some Linux desktops) or on the right side of the _menu bar_ (MacOS). The GUI is only used to configure and control the client or server processes.
|
||||
|
||||
### Windows Processes
|
||||
- Press `Ctrl + Shift + Esc` to open the _Task Manager_
|
||||
- Click on the _Details_ tab and click on the _Name_ header to sort by name
|
||||
- Look for the `barrier.exe` process if the GUI is running
|
||||
- Look for the `barrierd.exe` process
|
||||
- Look for the `barrierc.exe` process on a client
|
||||
- Look for the `barriers.exe` process on a server
|
||||
|
||||
### Linux/Unix/MacOS
|
||||
- Use [ps](https://en.wikipedia.org/wiki/Ps_(Unix)) and [grep](https://en.wikipedia.org/wiki/Grep) commands to find barrier processes:
|
||||
```shell
|
||||
ps -ax -o user,pid,command | grep -i [b]arrier
|
||||
```
|
||||
- Look for the `barrier` process if the GUI is running
|
||||
- Look for the `barrierc` process on a client
|
||||
- Look for the `barriers` process on a server
|
||||
|
||||
__Note:__ Including the brackets [] in the `grep` syntax prevents it from matching instances of `grep` in the process list.
|
||||
|
||||
[Back to Top](#top)
|
||||
|
||||
## <a name="server_reachability">Server Reachability (Ping)</a>
|
||||
Barrier needs network connectivity between machines to work. The easiest way to test this is with the [ping](https://en.wikipedia.org/wiki/Ping_(networking_utility)) or [Test-Connection](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.management/test-connection) commands.
|
||||
|
||||
### Windows Command Prompt
|
||||
```cmd
|
||||
ping <hostname or IP>
|
||||
```
|
||||
|
||||
### Windows PowerShell
|
||||
```powershell
|
||||
Test-Connection -ComputerName <hostname or IP>
|
||||
```
|
||||
|
||||
### Linux/Unix/MacOS Command Line
|
||||
```shell
|
||||
ping -c 4 <hostname or IP>
|
||||
```
|
||||
|
||||
__If successful you should see four replies with the IP address and the time (in milliseconds)__
|
||||
|
||||
__Steps to try if unsuccessful:__
|
||||
- Make sure that both devices are either on the same Local Area Network (LAN) or check that the LANs they are on are connected and routing
|
||||
- Make sure that ping (ICMP) is being allowed through any software firewalls or hardware firewalls between the devices. (This can be turned back off after troubleshooting is resolved)
|
||||
- If using a hostname, make sure you are able to resolve that hostname to an IP address (Local DNS Server, mDNS, Avahi, NETBIOS, `/etc/hosts`, or equivalent method). Alternatively, consider using IP addresses instead
|
||||
|
||||
[Back to Top](#top)
|
||||
|
||||
## <a name="server_listening">Server Listening (Port 24800)</a>
|
||||
The server listens for a network connection on port 24800. You can test connectivity to this port from both the server and its clients. Check connectivity from the server to itself first to make sure it is accepting connections, then check that you can connect to the server across the network from the client.
|
||||
|
||||
- Make sure the server has been started in the Barrier GUI or that the required [processes are running](#processes_running) first
|
||||
|
||||
### Windows PowerShell Test-NetConnection
|
||||
- In the PowerShell window run:
|
||||
```powershell
|
||||
Import-Module NetTCPIP
|
||||
Test-NetConnection -ComputerName <hostname or IP> -Port 24800
|
||||
```
|
||||
- If you see `TcpTestSucceeded : True` you are able to connect to the server
|
||||
|
||||
__Note:__ If you know of an __easy__ way to test SSL connectivity with Windows please feel free to contribute it here. This method only tests connectivity to the port.
|
||||
|
||||
### Windows OpenSSL Client Connect
|
||||
The `openssl` command used below for Linux/Unix/MacOS to test connectivity __and__ SSL encryption can be obtained for Windows from various third parties distributions. Check the [OpenSSL Wiki](https://wiki.openssl.org/index.php/Binaries) for more information.
|
||||
|
||||
### Linux/Unix/MacOS OpenSSL Client Connect
|
||||
- Use the [openssl](https://wiki.openssl.org/index.php/Command_Line_Utilities) command in the terminal to connect to the server by hostname:
|
||||
```shell
|
||||
$ openssl s_client -connect <hostname or ip>:24800 | head
|
||||
```
|
||||
- If you see `CONNECTED` you are able to connect to the server
|
||||
- If you see `Server Certificate` the SSL encryption is working
|
||||
- You may see `verify error:num=18:self signed certificate`. Barrier generates a self-signed certificate, so this is nothing to be concerned about
|
||||
|
||||
__Steps to try if unsuccessful:__
|
||||
- Make sure the Barrier server [process is runnning](#processes_running)
|
||||
- Make sure that port `24800` inbound is being allowed through any software firewalls or hardware firewalls between the devices
|
||||
- Make sure that port `24800` outbound is being allowed through any software firewalls on the client
|
||||
- Instructions for adding Barrier to the Windows firewall can be found [here](Adding-Barrier-to-the-Windows-Firewall.md)
|
||||
|
||||
[Back to Top](#top)
|
||||
|
||||
## <a name="multiple_instances">Multiple Instances</a>
|
||||
Multiple instances of the background services that Barrier uses (`barriers` on the server, and `barrierc` on the client) can cause issues. For example, if another `barriers` process is running in the backround it will prevent the current process from binding to port `24800` and you may see incorrect status in the GUI.
|
||||
|
||||
### Windows
|
||||
- Press `Ctrl + Shift + Esc` to open the _Task Manager_
|
||||
- Click on the _Details_ tab and click on the _Name_ header to sort by name
|
||||
- Make sure there is only one `barrier.exe` process if the GUI is running
|
||||
- Make sure there is only one `barriers.exe` and one `barrierd.exe` process if the server is running
|
||||
- Make sure there is only one `barrierc.exe` and one `barrierd.exe` process if the client is running
|
||||
|
||||
### Linux/Unix/MacOS
|
||||
- Use `grep` and `ps` to find barrier processes
|
||||
```shell
|
||||
ps -ax -o user,pid,command | grep -i [b]arrier
|
||||
```
|
||||
- Make sure there is only one `barrier` process if the GUI is running
|
||||
- Make sure there is only one `barriers` process if the server is running
|
||||
- Make sure there is only one `barrierc` process if the client is running
|
||||
|
||||
__Note:__ The barrier command line arguments may make a single command wrap on the terminal to more than one line
|
||||
|
||||
__Steps to try if unsuccessful:__
|
||||
- Try stopping all of the barrier processes (_End Task_ on Windows, `kill <pid>` on Linux/Unix/MacOS) and relaunching the program
|
||||
- Try restarting the computer
|
||||
|
||||
[Back to Top](#top)
|
||||
|
||||
## <a name="fingerprint_trust">Fingerprint Trust</a>
|
||||
Barrier uses fingerprints to validate that a malicious server is not trying to intercept a client connection. These fingerprints may be automatically generated if _Auto Config_ is selected in the client. If your client does not trust the fingerprint it will refuse the connection.
|
||||
|
||||
The _TrustedServers.txt_ file should contain the fingerprint found in the _Local.txt_ file on the server.
|
||||
|
||||
### View the server fingerprint in the GUI
|
||||
- Open the main Barrier GUI window
|
||||
- The _SSL Fingerprint:_ field in the _Server_ section shows the current server fingerprint
|
||||
|
||||
### View the fingerprints on Windows
|
||||
- Open _File Explorer_
|
||||
- In the _path bar_ enter `%LocalAppData%\Barrier\SSL\Fingerprints`
|
||||
- Double-click either _Local.txt_ for the server fingerprints, or _TrustedServers.txt_ to view the fingerprints trusted by the client
|
||||
|
||||
### View the fingerprints on MacOS
|
||||
- To view the trusted fingerprints on the client use the [more](https://en.wikipedia.org/wiki/More_(command)) command to view the _TrustedServers.txt_ file:
|
||||
```shell
|
||||
more ~/Library/Application\ Support/barrier/SSL/Fingerprints/TrustedServers.txt
|
||||
```
|
||||
- To view the server fingerprint on the server use the `more` command again:
|
||||
```
|
||||
more ~/Library/Application\ Support/barrier/SSL/Fingerprints/Local.txt
|
||||
```
|
||||
|
||||
### View the trusted fingerprints on Linux or Unix
|
||||
- To view the trusted fingerprints on the client use the [more](https://en.wikipedia.org/wiki/More_(command)) command to view the _TrustedServers.txt_ file:
|
||||
```shell
|
||||
more ~/.local/share/barrier/SSL/Fingerprints/TrustedServers.txt
|
||||
```
|
||||
- To view the server fingerprint on the server use the `more` command again:
|
||||
```shell
|
||||
more ~/.local/share/barrier/SSL/Fingerprints/Local.txt
|
||||
```
|
||||
|
||||
On Linux or Unix systems the barrier _TrustedServers.txt_ or _Local.txt_ files may not always be in the same place depending on your system configuration. If they are elsewhere, use the [find](https://en.wikipedia.org/wiki/Find_(Unix)) command to locate them.
|
||||
```
|
||||
find / -type f -name '*TrustedServers.txt' 2>/dev/null
|
||||
find / -type f -name '*Local.txt' 2>/dev/null
|
||||
```
|
||||
__Note 1:__ These `find` commands may find other files with the same names. Check that the path includes `barrier`
|
||||
|
||||
__Note 2:__ The `2>/dev/null` is to hide _Permission denied_ errors you would otherwise get from searching directories you do not have permission for as a normal user
|
||||
|
||||
__Steps to try if unsuccessful:__
|
||||
- Try to copy & paste the contents of _Local.txt_ on the server into the _TrustedServers.txt_ file manually
|
||||
|
||||
[Back to Top](#top)
|
||||
Loading…
Reference in New Issue