phantom/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2025-01-10 03:37:28 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1411 from nyxnor/cli-installation-instructions

Browse source 
Cli installation instructions
This commit is contained in:
Micah Lee 2021-09-03 14:38:03 -07:00 committed by GitHub
commit b09c3bc48b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 66 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
cli/README.md
View file

@ -22,14 +22,69 @@
## Installing OnionShare CLI
First, make sure you have `tor` installed. In Linux, install it through your package manager. In macOS, install it with [Homebrew](https://brew.sh): `brew install tor`.
First, make sure you have `tor` and `python3` installed. In Linux, install it through your package manager. In macOS, install it with [Homebrew](https://brew.sh): `brew install tor`. Second, OnionShare is written in python, and you can install the command line version use python's package manager `pip`.
Then install OnionShare CLI:
### Requirements
Debian/Ubuntu (APT):
```sh
sudo apt-get install tor python3-pip
```
Arch (Pacman):
```sh
sudo pacman -S tor python-pip
```
CentOS, Red Hat, and Fedora (Yum):
```sh
sudo yum install tor python3 python3-wheel
```
macOS (Homebrew):
```sh
brew install tor python
sudo easy_install pip
```
### Main
#### Installation
Install OnionShare CLI:
```sh
pip install onionshare-cli
pip install --user onionshare-cli
```
#### Set path
When you install programs with pip and use the --user flag, it installs them into ~/.local/bin, which isn't in your path by default. To add ~/.local/bin to your path automatically for the next time you reopen the terminal or source your shell configuration file, do the following:
First, discover what shell you are using:
```sh
echo $SHELL
```
Then apply the path to your shell file:
bash:
```sh
echo "PATH=\$PATH:~/.local/bin" >> ~/.bashrc
source ~/.bashrc
```
zsh:
```sh
echo "PATH=\$PATH:~/.local/bin" >> ~/.zshrc
source ~/.zshrc
```
#### Usage
Then run it with:
```sh

9
docs/source/install.rst
View file

@ -8,7 +8,7 @@ You can download OnionShare for Windows and macOS from the `OnionShare website <
.. _linux:
Install in Linux
Linux
----------------
There are various ways to install OnionShare for Linux, but the recommended way is to use either the `Flatpak <https://flatpak.org/>`_ or the `Snap <https://snapcraft.io/>`_ package.
@ -22,6 +22,13 @@ Snap support is built-in to Ubuntu and Fedora comes with Flatpak support, but wh
You can also download and install PGP-signed ``.flatpak`` or ``.snap`` packages from https://onionshare.org/dist/ if you prefer.
.. _pip:
Any OS with pip
---------------
If you want to install OnionShare just for the command line (onionshare-cli), please see the `README <https://github.com/onionshare/onionshare/blob/develop/cli/README.md>`_ in the Git repository for installation instructions with python package manager pip.
.. _verifying_sigs:
Verifying PGP signatures