da8e37c4a1
* Add some experiment code for crypto crate * feat: add crypto crate with ssl, rsa, ed25519 for https, encryption, signing * Implement aes encryption helper in crypto crate * ci: add dep for CI rust test (protobuf) * fix: try to fix window CI with next * fix: CI * ci: add dep for ubuntu * ci: fix * fix: openssl lib path in CI * fix: CI * update applications-rs, disable some tests * fix: CI * feat: add file transfer grpc proto and server setup * CI: try to fix CI * fix: missing proto in build.rs * ci: add cargo build before cargo test * fix: grpc file descriptor * ci: fix CI by removing a redundant main.rs * fix: disable local windows test in applications-rs which fails CI * ci: run CI rust test only on ubuntu, windows is failing. will be handled in another PR * fix: vue template * fix: allow unused variable * fix: remove node:buffer type from api shell.ts to avoid frontend build error * try to fix test in create-kunkun * upgrade api to 0.0.44, remove node:buffer * upgrade next template to 15 * feat: turn the default server into a https server * feat: make SSL certificate loadable from env * feat: add conditional SSL cert in debug mode, use local default cert, in production generate new self-signed cert every time app starts * chore: add vscode debug config * feat: add server public key * feat: setup sqlite db encryption * fix: settings hotkey * chore: add .gitkeep * ci: add node-fetch to dep for api package
Kunkun Custom UI Extension Template (Vue)
Custom UI Extension Documentation
This is a template for a custom UI extension.
This type of extension is basically a static website. You can use any frontend framework you like, this template uses Vue.
It is assumed that you have some knowledge of frontend development with Vue.
Development
Development is the same as developing a normal website.
pnpm install
pnpm dev
pnpm build
- To develop and preview the extension in Kunkun, you need to run the
Add Dev Extensioncommand in Kunkun, and register this extension's path.
In package.json, "devMain" is the url for development server, and "main" is the path to static .html file for production.
To load the extension in development mode, you have to enable it with Toggle Dev Extension Live Load Mode command in Kunkun. A Live badge will be shown on the commands. This indicates that dev extensions will be loaded from devMain instead of main.
Advanced
Multi-Command
To support multiple commands, you will need multiple .html files as entrypoints, and register each command in package.json.
It is recommended to use a meta-framework and build with SSG rendering mode, which comes with routing and will output multiple .html files.
Kunkun provides meta-framework templates for Nuxt, Next, SvelteKit.
Verify Build and Publish
pnpm build # make sure the build npm script works
npx kksh@latest verify # Verify some basic settings before publishing
It is recommended to build the extension with the same environment our CI uses.
The docker image used by our CI is huakunshen/kunkun-ext-builder:latest.
You can use the following command to build the extension with the same environment our CI uses.
This requires you to have docker installed, and the shell you are using has access to it via docker command.
npx kksh@latest build # Build the extension with
pnpm is used to install dependencies and build the extension.
The docker image environment also has node, pnpm, npm, bun, deno installed.
If your build failed, try debug with huakunshen/kunkun-ext-builder:latest image in interative mode and bind your extension volume to /workspace.
After build successfully, you should find a tarball file ends with .tgz in the root of your extension.
The tarball is packaged with npm pack command. You can uncompress it to see if it contains all the necessary files.
This tarball is the final product that will be published and installed in Kunkun. You can further verify your extension by installing this tarball directly in Kunkun.
After verifying the tarball, it's ready to be published.
Fork KunkunExtensions repo, add your extension to the extensions directory, and create a PR.
Once CI passed and PR merged, you can use your extension in Kunkun.