Skip to main content
Version: 4.x

FAQ

Frequently asked questions from the community with the official answers. Please look for a similar question here before asking.

Installation and runtime problems​

See Installation FAQ and Usage FAQ.

Will Spug support more features?​

Yes, new features are being developed all the time. Share your ideas on the WeChat official account or open a GitHub issue.

Is the password I enter when verifying a host safe?​

Yes. The password is used once to set up key-based login and is never stored or used anywhere else. Afterwards Spug always logs in with its SSH key, see Host management.

I do not need the monitoring module. Can I skip the runmonitor service?​

Yes, and the same applies to runscheduler if you do not use scheduled tasks. Batch execution, deployments and pipelines depend on runworker, so keep that one running.

Do I have to follow the WeChat official account to use the built-in alert service?​

Yes. The built-in WeChat / email alert service is provided for users who cannot run their own, and it requires a service token configured under System / Settings / Basic Settings / Service Token, plus the personal WeChat token of every alert contact. The DingTalk, WeCom and Feishu bot channels and a custom mail server do not need the token.

Why is the built-in alert service not open source?​

WeChat, email and SMS all need sensitive settings such as the WeChat APP_ID or mail account credentials, so it cannot be open-sourced for now. You can configure your own mail server under System Settings / Alert Service Settings instead.

How do I get SMS or phone call alerts?​

Spug integrates with Push Assistant. Bind your Push Assistant account under System / Settings / Push Service and pipelines can send SMS, phone call, email and WeChat official account messages through the Push Assistant node; for monitoring alerts see the Push Assistant guide.

Can the interface be switched to English?​

Yes. Since 4.0 the interface is available in English and Simplified Chinese. Click the globe icon in the header to switch; the choice is stored in the browser.