sspush is intended to make it simple to upload and share screenshots/images/files with no intervention from the user via a public link that points to a server you own.
- web server remote server that you have access to.
- SSH key pair for web-server login.
- xclip locally (For Linux users using x11).
- maim locally (For Linux users using x11).
- slop locally (For Linux users using x11).
- wl-clipboard locally (For Linux users using Wayland).
- grim locally (For Linux users using Wayland).
- slurp locally (For Linux users using Wayland).
- spectacle locally (For Linux users on KDE).
- wf-recorder locally (For Linux users using Wayland).
- screencapture locally (Default on macOS).
- libnotify locally (For Linux users, only required if you need notifications).
To use the sspush, follow the instructions below:
-
Clone the sspush repository to your local machine using the command:
git clone https://github.com/CtrlAltMech/sspush.git -
Navigate to the cloned repository directory using the command
cd sspush -
Make the sspush script executable using the command
chmod +x sspush -
Run the script using the command
./sspush
- On first use (when no config file is present) you will be prompted to generate an empty configuration file.
# Config file for sspush
# Filepath where screenshots are stored
SSFILEPATH=""
# Remote directory where screenshots are stored
REMOTEDIR=""
# Username for access to server
USERNAME="$USER"
# Private key location (script only works with ssh keys)
KEYPATH=""
# SSH port
PORT="22"
# Server IP or DNS name
SERVER=""
# Base link location (Link minus the image that the user will visit).
# Example https://mysite.net/pics/<your image name>.jpg"
BASELINK=""
# Allow/Deny desktop notifications
NOTIFICATIONS=""
# Specify which clipboard to use (clipboard or primary)
CLIPBOARD="clipboard"
Be aware: references to your home directory in the conf file must be done with $HOME, not ~. $HOME is a shell variable, and ~ is an expansion symbol.
- Once the configuration file is created your editor should open to edit the file.
- When the configuration file is filled out run the command again to push your file.
- A link will be copied to your clipboard as well as printed out to the terminal.
sspush- Will post most recent file/screencapture in screenshots folder specified in config file.sspush -i <optional filename>- Will start interactive mode allowing you to select a portion of the screen and post.sspush -a <optional filename>- Captures everything on all screens and posts.sspush -h <optional filename>- Prints syntax help out to terminal.sspush -v <optional filename>- Captures video (Interactive capture ONLY on linux, Fullscreen ONLY on macOS)
I would love to hear if there are any bugs or a requested feature! ❤️
If you would like to contribute to the sspush project, follow the instructions below:
- Fork the sspush repository to your Github account.
- Clone your fork of the sspush repository to your local machine.
- Make your changes to the sspush script.
- Push your changes to your fork of the sspush repository.
- Submit a pull request to the original sspush repository.
The sspush bash script is released under the GNU General Public License v3.0. See the LICENSE file for more information.
- Dependency check (Setup for a couple of dependencies, need to work in the rest of them)
- General code refactoring.
- Configuration sanitization.
- Format more according to Google style guide
- Debug flag (for the video capture mainly, but other stuff as well.)
- Issue with portrait monitor video capture being treated like landscape mode in Wayland. Issue listed here. Needs a fix.
- Issue with Firefox in macOS, wayland, and X11 (3 different machines) not playing unless the pixel format was set to yuv420p. This has been set to run like this by default.
- (macOS specifically) Make sure you have given permissions for screenrecording to the terminal you use. You will receive a prompt to do so if not.