PLUGIN SETUP DOCUMENTATION
Installation Guide
Follow these steps to deploy AliveOS Keep Alive. From initial activation to advanced shortcode integration, get your system running in minutes.
Wake Lock API(Browser)
WordPress REST(Backend)
Gutenberg Blocks(Editor)
AJAX Nonces(Security)
Chart.js(Telemetry)
PHP 8.0+(Engine)
01
Setup|
<AliveOSPlugin active={true} />Ready
Deployment PhaseState: System Activation
Plugin Installation
Standard WordPress directory deployment and activation
Implementation Steps
- Download the plugin ZIP from the official WordPress repository
- Navigate to Plugins > Add New in your WordPress dashboard
- Upload the ZIP file and click Install Now
- Activate the plugin to initialize the Wake Lock API
- Verify system status in the admin toolbar monitor
Requires WordPress 6.0+
View DocsCode Snippet
// aliveos-keep-alive.php
define('ALIVEOS_VERSION', '1.0.0');
function aliveos_init() {
wp_enqueue_script('aliveos-core',
plugin_dir_url(__FILE__) . 'js/core.js',
[], ALIVEOS_VERSION, true);
}
add_action('wp_enqueue_scripts', 'aliveos_init');Secure & ValidatedPHP 8.0+
02
Config|
<Dashboard settings={userConfig} />Active
Core SettingsState: User Preferences
Admin Dashboard
Configure session tracking and productivity tools
Implementation Steps
- Access the AliveOS settings page via the sidebar menu
- Toggle Wake Lock persistence for specific user roles
- Configure mouse and keyboard activity tracking sensitivity
- Enable productivity modules like Pomodoro and To-do
- Save settings using secure nonce-validated AJAX calls
Requires WordPress 6.0+
View DocsCode Snippet
// admin/settings.php
function aliveos_save_settings() {
check_ajax_referer('aliveos_nonce', 'security');
$data = sanitize_text_field($_POST['config']);
update_option('aliveos_config', $data);
wp_send_json_success();
}Secure & ValidatedPHP 8.0+
03
Usage|
[aliveos_dashboard theme='cyberpunk']Live
Production ReadyState: Frontend Rendering
Shortcode Integration
Embed live telemetry and tools into any page
Implementation Steps
- Use [aliveos_dashboard] shortcode in any post or page
- Apply themes via attributes: theme='ocean' or 'neon'
- Insert the Gutenberg block for visual configuration
- Monitor real-time uptime and session timer metrics
- View daily statistics and weekly activity charts
Requires WordPress 6.0+
View DocsCode Snippet
// includes/shortcodes.php
function aliveos_shortcode($atts) {
$a = shortcode_atts(['theme' => 'dark'], $atts);
return '<div id="aliveos-app"
data-theme="' . esc_attr($a['theme']) . '">
</div>';
}
add_shortcode('aliveos_dashboard', 'aliveos_shortcode');Secure & ValidatedPHP 8.0+
Need Further Assistance?
Check our full documentation for advanced API hooks, theme customization, and troubleshooting common environment issues.
AliveOS Support
Technical Queries
Answers regarding browser Wake Lock support, mobile compatibility, database footprint, and shortcode customization parameters.
AliveOS utilizes the browser Wake Lock API to prevent your system from entering sleep mode. It maintains an active session state as long as the dashboard tab remains open.
Need more help?
Our technical team is ready to assist with plugin installation, API configuration, or custom integration requests.