Ubersmith

https://docs.ubersmith.com
Admin
Ubersmith is a subscription billing, client management, device monitoring, and ticketing platform...
Tokens:333,721
Snippets:3,724
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Installer prompt transcript

Source: https://docs.ubersmith.com/article.php?id=231&oid=36

Example terminal output while the installer checks for pip, installs Ansible and Ubersmith, and asks for the installation directory, hostname, and admin email.

```text
Checking for pip...  
Installing Ansible...  
Installing Ubersmith...  
Choose an installation directory for Ubersmith [/usr/local/ubersmith]:  
Enter the hostname where you will be hosting Ubersmith [ubersmith.example.com]:   
Enter the email address of the Ubersmith administrator [admin@example.org]:

```

--------------------------------

### Remove Setup Directory After Install

Source: https://docs.ubersmith.com/article.php?id=231

Remove /setup to load the UI. Run from /usr/local/ubersmith using Docker Compose.

```bash
docker-compose exec web rm -rf /var/www/ubersmith_root/app/www/setup
```

--------------------------------

### Start Docker service

Source: https://docs.ubersmith.com/article.php?id=231

Command to start the Docker service to ensure it is up and running.

```bash
service docker start
```

--------------------------------

### Start Ubersmith backup container (foreground)

Source: https://docs.ubersmith.com/article.php?id=314&oid=36

Runs the backup container in the foreground as root, generating a physical backup using Percona's xtrabackup. Output shows backup progress.

```bash
# cd /usr/local/ubersmith# docker-compose -p ubersmith up backup
```

--------------------------------

### Start Ubersmith with Docker Compose

Source: https://docs.ubersmith.com/article.php?id=43&oid=36

Commands to navigate to the installation directory and start the Ubersmith containers in detached mode.

```bash
# cd /usr/local/ubersmith
# docker compose up -d
```

--------------------------------

### Run the Installer Script as Root

Source: https://docs.ubersmith.com/article.php?id=231

Run as root: ./install_ubersmith.sh for Ubersmith or ./install_appliance.sh for the Ubersmith Appliance. Do not deploy both to the same host.

```bash
if [ "$(id -u)" -ne 0 ]; then echo "Must run as root" >&2; exit 1; fi
./install_ubersmith.sh
```

```bash
./install_appliance.sh
```

--------------------------------

### Decompress installer tarball example with version 3.1.13

Source: https://docs.ubersmith.com/article.php?id=231&oid=36

Concrete example of the tar command using the release version v3.1.13. Run while logged in as root.

```shell
tar zxf ubersmith-installer-v3.1.13.tar.gz

```

--------------------------------

### Troubleshoot web container startup

Source: https://docs.ubersmith.com/article.php?id=43&oid=36

Navigate to the Ubersmith directory and start the web container in the foreground to view error messages.

```bash
# cd /usr/local/ubersmith
# docker compose up web
```

--------------------------------

### Make a Database Backup

Source: https://docs.ubersmith.com/article.php?id=43&oid=36

Command to start the backup container, which runs Percona xtrabackup and saves the snapshot to the local directory.

```bash
# cd /usr/local/ubersmith
# docker compose up backup
```

--------------------------------

### Start Redis containers with docker-compose

Source: https://docs.ubersmith.com/article.php?id=157

Run this command as root from the Ubersmith installation directory to bring up a cluster of three Redis containers.

```bash
docker-compose -p ubersmith up --scale redis=3 -d redis
```
Tokens:
Raw