48 lines
2.0 KiB
Markdown
48 lines
2.0 KiB
Markdown
|
# Pinnwand
|
||
|
|
|
||
|
|
Pinnwand is a straightforward pastebin service designed for simplicity and ease of use. It provides a clean web interface to share and manage text snippets, code, or notes. It supports features like syntax highlighting, expiration times, and revocation.
|
||
|
|
|
||
|
|
## Pinnwand Installer Script
|
||
|
|
|
||
|
|
The Pinnwand installer script is a Bash script designed to automate the installation, upgrade, and setup of Pinnwand on a Linux system. It sets up and installs Pinnwand into a Python virtual environment, keeping it separate from the base system.
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
- Python 3.8 or higher with `pip`
|
||
|
|
- Git installed on the system.
|
||
|
|
|
||
|
|
### Features
|
||
|
|
|
||
|
|
1. **Automated Installation**: The script can install Pinnwand by cloning its repository and setting up a virtual environment.
|
||
|
|
2. **Upgrade Support**: It can update Pinnwand to the latest version, a specified Git reference or main development branch.
|
||
|
|
3. **Custom Source Testing**: A `USE_LOCAL_SRC` option allows using manually downloaded sources and avoids the `git` dependency.
|
||
|
|
|
||
|
|
### Usage
|
||
|
|
|
||
|
|
1. Clone or download the script.
|
||
|
|
2. Set the username, install path and source path in the script.
|
||
|
|
3. Run the script as the `pinnwand` user:
|
||
|
|
```bash
|
||
|
|
sudo -u pinnwand-user ./pinnwand-installer.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running pinnwand
|
||
|
|
|
||
|
|
Create a `config.toml` with desired configuration options.
|
||
|
|
|
||
|
|
An example config file is available in the source tree under `etc/pinnwand-toml-example`.
|
||
|
|
|
||
|
|
### Manually
|
||
|
|
Specify the configuring file and the TCP/IP listening port on the command line.
|
||
|
|
```bash
|
||
|
|
sudo -u pinnwand-user path/to/pinnwand/venv/bin/pinnwand --configuration-path config.toml http --port 1234
|
||
|
|
```
|
||
|
|
|
||
|
|
### OpenRC init.d script
|
||
|
|
The provided init scripts help you run pinnwand as a service on a OpenRC system such as Gentoo and Alpine Linux.
|
||
|
|
|
||
|
|
1. Cooy `pinnwand.initd` to `/etc/init.d/pinnwand`
|
||
|
|
2. Cooy `pinnwand.confd` to `/etc/conf.d/pinnwand`
|
||
|
|
3. Set the correct user and path in `/etc/conf.d/pinnwand`
|
||
|
|
4. Run `rc-update add pinnwand` to enable autostart on boot.
|
||
|
|
5. Run `rc-service pinnwand start` to start pinnwand now.
|