runtipi / cli Goto Github PK

View Code? Open in Web Editor NEW

4.0 4.0 4.0 324 KB

The command line interface to configure and interact with Runtipi

Home Page: https://runtipi.io/

License: GNU General Public License v3.0

Rust 100.00%

cli runtipi

cli's Introduction

Tipi — A personal homeserver for everyone

💡 Tipi is built with TypeScript, Next.js app router and Drizzle ORM! If you want to collaborate on a cool project, join the discussion on Discord!

Join the community

⚠️ Tipi is built and maintained by volunteers. There is no guarantee of support or security when you use Tipi. While the system is considered stable, it is still in active development and may contain bugs.

Tipi is a personal homeserver orchestrator that makes it easy to manage and run multiple services on a single server. It is based on Docker and comes with a simple web interface to manage your services. Tipi is designed to be easy to use, so you don't have to worry about manual configuration or networking. Simply install Tipi on your server and use the web interface to add and manage services. You can see a list of available services in the App Store repo and request new ones if you don't see what you need. To get started, follow the installation instructions below.

Getting started

Visit our website runtipi.io for installation instructions, documentation and guides.

Demo

You can try out a demo of Tipi at demo.runtipi.io using the following credentials:

username: [email protected]
password: password

📚 Documentation

You can find more documentation and tutorials / FAQ on runtipi.io

❤️ Contributing

Tipi is made to be very easy to plug in new apps. We welcome and appreciate new contributions.

If you want to add a new app or feature, you can follow the Contribution guide for instructions on how to do so.

We are looking for contributions of all kinds. If you know design, development, or have ideas for new features, please get in touch.

📜 License

Tipi is licensed under the GNU General Public License v3.0. TL;DR — You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

🗣 Community

🙏 Acknowledgements

GitHub - Thanks for generously giving us access to your full product suite
Freepik - Thanks for providing a free logo for the project
Sentry - Thanks for providing error tracking for the project
Crowdin - Thanks for providing localization management for the project
CodeRabbit - Thanks for providing free AI code reviews in our Pull Requests

🔀 Server Actions - Component Flow

✨ Contributors

Thanks goes to these wonderful people (emoji key):

_{Nicolas Meienberger} 💻 🚇 ⚠️ 📖	_ArneNaessens 💻 🤔 ⚠️	_DrMxrcy 💻 🤔 ⚠️ 🖋 📣 💬 👀	_Cooper 💻	_JTruj1ll0923 💻	_Stetsed 💻	_{Jones_Town} 💻
_{Rushi Chaudhari} 💻	_{Robert Blaine} 💻	_{Seth For Privacy} 💻	_Prajna 💻	_{Justin Moy} 💻	_dextreem 💻	_{Brahim Hadriche} 💻
_{Andrew Brereton} 🖋	_{Freddie Sackur} 💻 📖	_Innocentius 🌍	_Alex 💻	_{Ryan Wang} 💻	_simonandr 🖋	_iepure 🌍
_{Sergey Kodolov} 🌍 💻	_sclaren 💻	_mcmeel 💬 🤔 💻 📖	_NoisyFridge 🌍	_Bvoxl 🌍	_m-lab-0 🌍	_dannkunt 🌍
_Schmanko 🌍	_{Nghia Lele} 🌍	_{amusingimpala75} 💻	_David 🌍	_Stavros 🌍 💻 ⚠️ 📖	_loxiry 🌍	_JigSaw 💻
_DireMunchkin 💻	_{Fabio Cingottini} 🌍	_him 💻	_{CHALOPIN Clément} 💻	_{Geetansh Jindal} 💻	_{Olivier Garcia} 💻	_qcoudeyr 💻
_{Armand Gillot} 💻	_Jaffo73 ⚠️ 💻	_{Jorge Montejo} 💻	_{Frédéric Cilia} 💻	_{Agustín Carrasco} 💻	_{Thibault Claude} 💻	_{Joshua Banks} 💻 📖
_{hex-developer} 💻	_{Gabriel Farias Nunes} 🌍	_{Boogie Cigdemoglu} 📖

Did you contribute and want to see your name listed in the README? Write a comment here This project follows the all-contributors specification. Contributions of any kind welcome!

cli's People

Contributors

Stargazers

Watchers

Forkers

callumteesdale jnth ciliafred sergi0g

cli's Issues

[BUG] error message when using runtipi-cli app start-all

Checklist

Before opening your issue be sure to have completed all those tasks.

My issue is not related to an app I installed through tipi (If so please open your issue here: https://github.com/runtipi/runtipi-appstore/issues)
My issue is not a support request (eg: "My instance is not running after update". If so please ask for support in the help section of our Discord server)
I have searched for an already existing issue with similar context and errors. My issue has not yet been reported.
I have included a clear description and steps to reproduce.
I have included logs from the file runtipi/logs/error.log if relevant

Describe the bug
there is an error on the cli when using sudo ./runtipi-cli app start-all

sudo ./runtipi-cli app start-all
Welcome to Runtipi CLI ✨

⠴ Starting all apps...
thread 'main' panicked at src/commands/app.rs:161:80:
called `Result::unwrap()` on an `Err` value: reqwest::Error { kind: Request, url: Url { scheme: "http", cannot_be_a_base: false, username: "", password: None, host: Some(Domain("localhost")), port: None, path: "/worker-api/apps/start-all", query: None, fragment: None }, source: TimedOut }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

All apps are still being started.

Server (please complete the following information):

OS: Ubuntu 22.04
Tipi Version 3.0.3

Update to latest takes Infinity/100

Following up steps to update:

sudo ./runtipi-cli update latest

Update process takes forever:

Welcome to Tipi CLI ✨ ✓ Target version: v3.0.3 ✓ Download url: https://github.com/runtipi/runtipi/releases/download/v3.0.3/runtipi-cli-linux-x64 ✓ App 2fauth stopped ✓ App actual-budget stopped ✓ App adguard stopped ✓ App code-server stopped ✓ App dashdot stopped ✓ App gotify stopped ✓ App owncloud stopped ✓ App pihole stopped ✓ App plex stopped ✓ App postfix-relay stopped ✓ App wg-easy stopped ✓ Tipi successfully stopped ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 100% | ETA: NULLs | Infinity/100

OS

Distributor ID: Ubuntu
Description: Ubuntu 22.04.3 LTS
Release: 22.04
Codename: jammy

Runtipi

Current version: v2.5.0

Installation fails

Following installation steps fail:

error: linker `cc` not found
|
= note: No such file or directory (os error 2)

error: could not compile proc-macro2 (build script) due to 1 previous error
warning: build failed, waiting for other jobs to finish...
error: could not compile libc (build script) due to 1 previous error

System, libraries and dependency versions being used

OS

Distributor ID: Ubuntu
Description: Ubuntu 22.04.3 LTS
Release: 22.04
Codename: jammy

Rust

rustc 1.76.0 (07dca489a 2024-02-04)

Dependencies

cc?

support runtipi-cli app list and --all

Using a cli, I would like to be able to update all apps. One approach I was thinking was to list all apps and update them all manually with a script.

I can't find a command using the cli to show every installed/available apps, proposition is runtipi-cli app list to report install apps and adding --all to report list of available apps.
cli should support update of all apps ans skip in case of errors: proposition is to use: runtipi-cli app update --all

[BUG] Needs directories to start, Symlink do not suffice

Describe the bug
I've a lot of symlinks in my media directory. (downloads/movies/music/tv). Whenever I try to start runtipi it tries to create the directories and fails to start. Log says:
Error: ENOTDIR: not a directory, mkdir '/data/media/downloads'.

If I rename the symlinks, let him create the directories, it starts up. I can then delete them and rename the symlinks again which is kind of tedious but works :)

To Reproduce
Steps to reproduce the behavior:

Create Symlink instead of /media/downloads directory
Try to start runtipi

Expected behavior
It should not care if the directories are directories or symlinks and just start up.

Server (please complete the following information):
--- System information ---
┌──────────────┬──────────────────┐
│ OS │ linux - Ubuntu 23.10 │
├──────────────┼──────────────────┤
│ OS Version │ 6.5.0-26-generic │
├──────────────┼──────────────────┤
│ Memory (GB) │ 15.00 │
├──────────────┼──────────────────┤
│ Architecture │ amd64 │
└──────────────┴──────────────────┘

--- Tipi configuration ---
┌───────────────────────────┬────┐
│ Custom tipi docker config │ No │
└───────────────────────────┴────┘

[BUG] Error when stopping app from CLI

Checklist

Before opening your issue be sure to have completed all those tasks.

My issue is not related to an app I installed through tipi (If so please open your issue here: https://github.com/runtipi/runtipi-appstore/issues)
My issue is not a support request (eg: "My instance is not running after update". If so please ask for support in the help section of our Discord server)
I have searched for an already existing issue with similar context and errors. My issue has not yet been reported.
I have included a clear description and steps to reproduce.
I have included the result of the command ./runtipi-cli debug
I have included logs from the file runtipi/logs/error.log if relevant
I am using a custom docker compose file (user-config/tipi-compose.yml)

Describe the bug
I ran the command:

 ./runtipi-cli app stop zipline

and I received the error below. The docker container was not stopped

Warning ⚠️: If you use a custom docker compose file (located in user-config/tipi-compose.yml) please try to start runtipi without it before submitting an issue. If the issue persists even without the custom docker compose file then proceed to open an issue.

To Reproduce
Steps to reproduce the behavior:

Just try to stop it.

Expected behavior
no error

Screenshots
./runtipi-cli app stop zipline

Welcome to Runtipi CLI ✨

⠸ Stopping app zipline...                                                                                                                                       thread 'main' panicked at src/commands/app.rs:167:80:
called `Result::unwrap()` on an `Err` value: reqwest::Error { kind: Request, url: Url { scheme: "http", cannot_be_a_base: false, username: "", password: None, host: Some(Ipv4(192.168.1.41)), port: None, path: "/worker-api/apps/zipline/stop", query: None, fragment: None }, source: TimedOut }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

If applicable, add screenshots to help explain your problem.

Server (please complete the following information):

OS: ubuntu 23.10
Tipi Version : latest as of today

Additional context

--- System information ---
┌──────────────┬──────────────────┐
│ OS           │ linux            │
├──────────────┼──────────────────┤
│ OS Version   │ 6.5.0-28-generic │
├──────────────┼──────────────────┤
│ Memory (GB)  │ 10.69            │
├──────────────┼──────────────────┤
│ Architecture │ amd64            │
└──────────────┴──────────────────┘

--- Tipi configuration ---
┌───────────────────────────┬────┐
│ Custom tipi docker config │ No │
└───────────────────────────┴────┘

--- Settings.json ---
{
  "allowAutoThemes": true,
  "allowErrorMonitoring": false,
  "appsRepoUrl": "https://github.com/runtipi/runtipi-appstore",
  "demoMode": false,
  "dnsIp": "192.168.0.2",
  "guestDashboard": false,
  "internalIp": "192.168.0.52",
  "localDomain": "tipi.local",
  "persistTraefikConfig": false,
  "postgresPort": 5432,
  "storagePath": "/home/steve/Downloads/runtipi"
}

--- Environment variables ---
┌───────────────────┬──────────────────────────────────────────────────────────────────┐
│ POSTGRES_PASSWORD │ <redacted>                                                       │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ REDIS_PASSWORD    │ <redacted>                                                       │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ APPS_REPO_ID      │ 29ca930bfdaffa1dfabf5726336380ede7066bc53297e3c0c868b27c97282903 │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ APPS_REPO_URL     │ https://github.com/runtipi/runtipi-appstore                      │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ TIPI_VERSION      │ v3.1.3                                                           │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ INTERNAL_IP       │ 192.168.1.41                                                     │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ ARCHITECTURE      │ amd64                                                            │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ JWT_SECRET        │ <redacted>                                                       │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ ROOT_FOLDER_HOST  │ /home/steve/Downloads/runtipi                                    │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ STORAGE_PATH      │ /home/steve/Downloads/runtipi                                    │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ NGINX_PORT        │ 80                                                               │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ NGINX_PORT_SSL    │ 443                                                              │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ DOMAIN            │ <redacted>                                                       │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_HOST     │ runtipi-db                                                       │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_DBNAME   │ tipi                                                             │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_USERNAME │ tipi                                                             │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_PORT     │ 5432                                                             │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ REDIS_HOST        │ runtipi-redis                                                    │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ DEMO_MODE         │ false                                                            │
├───────────────────┼──────────────────────────────────────────────────────────────────┤
│ LOCAL_DOMAIN      │ tipi.local                                                       │
└───────────────────┴──────────────────────────────────────────────────────────────────┘

--- Docker containers ---
┌───────────────────────┬────┐
│ runtipi-reverse-proxy │ Up │
├───────────────────────┼────┤
│ runtipi-redis         │ Up │
├───────────────────────┼────┤
│ runtipi-db            │ Up │
└───────────────────────┴────┘

Updated by @meienberger (formatting)

Contributors

Reset password link

When resetting the password, it would be a good idea to show the link to the /reset-password page beside the Password reset request created message. But not sure if the cli knows the ip or de address.

Update to version 2.5.1 takes forever

Related to #25 but trying to update to next 2.5.x version:

sudo ./runtipi-cli update 2.5.1

Update process takes forever:

Welcome to Tipi CLI ✨ ✓ Target version: 2.5.1 ✓ Download url: https://github.com/runtipi/runtipi/releases/download/2.5.1/runtipi-cli-linux-x64 ✓ App 2fauth stopped ✓ App actual-budget stopped ✓ App adguard stopped ✓ App code-server stopped ✓ App dashdot stopped ✓ App gotify stopped ✓ App owncloud stopped ✓ App pihole stopped ✓ App plex stopped ✓ App postfix-relay stopped ✓ App wg-easy stopped ✓ Tipi successfully stopped ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 100% | ETA: NULLs | Infinity/100

OS

Distributor ID: Ubuntu
Description: Ubuntu 22.04.3 LTS
Release: 22.04
Codename: jammy

Runtipi

Current version: v2.5.0

Failed to update app.

I am able to update some apps using the cli but not all. It hangs forever in the GUI so I try to debug it further.

./runtipi-cli app update immich
Welcome to Runtipi CLI ✨

✗ Failed to update app.
Error: Error sending request: reqwest::Error { kind: Request, url: Url { scheme: "http", cannot_be_a_base: false, username: "", password: None, host: Some(Ipv4(192.168.0.52)), port: None, path: "/worker-api/apps/immich/update", query: None, fragment: None }, source: TimedOut }

in error.log, there is nothing

in app.log:

worker: 2024-08-20T07:05:54.877Z - info > 	Updating app immich
worker: 2024-08-20T07:05:55.111Z - info > 	Running docker compose with args --env-file /app-data/immich/app.env --project-name immich -f /data/apps/immich/docker-compose.yml -f /data/repos/29ca930bfdaffa1dfabf5726336380ede7066bc53297e3c0c868b27c97282903/apps/docker-compose.common.yml up --detach --force-recreate --remove-orphans
worker: 2024-08-20T07:06:02.446Z - info > 	Running docker compose with args --env-file /app-data/immich/app.env --project-name immich -f /data/apps/immich/docker-compose.yml -f /data/repos/29ca930bfdaffa1dfabf5726336380ede7066bc53297e3c0c868b27c97282903/apps/docker-compose.common.yml down --rmi all --remove-orphans
worker: 2024-08-20T07:06:24.091Z - info > 	Deleting folder /data/apps/immich
worker: 2024-08-20T07:06:24.095Z - info > 	Copying folder /data/repos/29ca930bfdaffa1dfabf5726336380ede7066bc53297e3c0c868b27c97282903/apps/immich to /data/apps/immich
worker: 2024-08-20T07:06:24.118Z - info > 	Running docker compose with args --env-file /app-data/immich/app.env --project-name immich -f /data/apps/immich/docker-compose.yml -f /data/repos/29ca930bfdaffa1dfabf5726336380ede7066bc53297e3c0c868b27c97282903/apps/docker-compose.common.yml pull

./runtipi-cli debug
Welcome to Runtipi CLI ✨

⚠️ Make sure you have started tipi before running this command

--- System information ---
┌──────────────┬──────────────────┐
│ OS           │ linux            │
├──────────────┼──────────────────┤
│ OS Version   │ 6.8.0-39-generic │
├──────────────┼──────────────────┤
│ Memory (GB)  │ 10.70            │
├──────────────┼──────────────────┤
│ Architecture │ amd64            │
└──────────────┴──────────────────┘

--- Tipi configuration ---
┌───────────────────────────┬──────┐
│ Custom tipi docker config │ No │
└───────────────────────────┴──────┘

--- Settings.json ---
{
  "allowAutoThemes": true,
  "allowErrorMonitoring": false,
  "appsRepoUrl": "https://github.com/runtipi/runtipi-appstore",
  "demoMode": false,
  "dnsIp": "192.168.0.2",
  "domain": "",
  "guestDashboard": false,
  "internalIp": "192.168.0.52",
  "localDomain": "tipi.local",
  "persistTraefikConfig": false,
  "postgresPort": 5432,
  "storagePath": "/home/steve/Downloads/runtipi"
}

--- Environment variables ---
┌───────────────────────┬──────────────────────────────────────────────────────────────────┐
│ POSTGRES_PASSWORD     │ <redacted>                                                       │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ REDIS_PASSWORD        │ <redacted>                                                       │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ APPS_REPO_ID          │ 29ca930bfdaffa1dfabf5726336380ede7066bc53297e3c0c868b27c97282903 │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ APPS_REPO_URL         │ https://github.com/runtipi/runtipi-appstore                      │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ TIPI_VERSION          │ v3.5.2                                                           │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ INTERNAL_IP           │ 192.168.0.52                                                     │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ ARCHITECTURE          │ amd64                                                            │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ JWT_SECRET            │ <redacted>                                                       │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ ROOT_FOLDER_HOST      │ /home/steve/Downloads/runtipi                                    │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ RUNTIPI_APP_DATA_PATH │ /home/steve/Downloads/runtipi                                    │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ NGINX_PORT            │ 80                                                               │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ NGINX_PORT_SSL        │ 443                                                              │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ DOMAIN                │ <redacted>                                                       │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_HOST         │ runtipi-db                                                       │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_DBNAME       │ tipi                                                             │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_USERNAME     │ tipi                                                             │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ POSTGRES_PORT         │ 5432                                                             │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ REDIS_HOST            │ runtipi-redis                                                    │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ DEMO_MODE             │ false                                                            │
├───────────────────────┼──────────────────────────────────────────────────────────────────┤
│ LOCAL_DOMAIN          │ tipi.local                                                       │
└───────────────────────┴──────────────────────────────────────────────────────────────────┘

--- Docker containers ---
┌───────────────────────┬──────┐
│ runtipi-reverse-proxy │ Up │
├───────────────────────┼──────┤
│ runtipi               │ Up │
├───────────────────────┼──────┤
│ runtipi-redis         │ Up │
├───────────────────────┼──────┤
│ runtipi-db            │ Up │
└───────────────────────┴──────┘
^ If a container is not 'Up', you can run the command `docker logs <container_name>` to see the logs of that container.

runtipi / cli Goto Github PK

cli's Introduction

Tipi — A personal homeserver for everyone

Join the community

Getting started

Demo

📚 Documentation

❤️ Contributing

📜 License

🗣 Community

🙏 Acknowledgements

🔀 Server Actions - Component Flow

✨ Contributors

cli's People

Contributors

Stargazers

Watchers

Forkers

cli's Issues

Checklist

OS

Runtipi

System, libraries and dependency versions being used

OS

Rust

Dependencies

Checklist

OS

Runtipi

Recommend Projects

Recommend Topics

Recommend Org