GSoC 2025 Project under the OpenAFS organization
This GNOME Shell extension aims to provide a graphical interface for managing the OpenAFS client on Linux desktops. OpenAFS is a powerful distributed file system widely adopted in academic and research settings, but its reliance on CLI tools can make it less approachable for everyday users.
This extension simplifies and enhances user interaction with OpenAFS by integrating a GUI directly into the GNOME Shell top bar.
- ✅ Start and stop the OpenAFS client via systemd
- ✅ Toggle autostart for the OpenAFS client (enable/disable on boot)
- ✅ View token expiration and current AFS cell name (or “cell connectivity”)
- ✅ Real-time status updates for client and token information
- ✅ User notifications for successful or failed operations
- ✅ Dynamic UI feedback during client and autostart actions
- GJS (GNOME JavaScript) for writing the extension logic
- GNOME Shell APIs for UI and system integration
- GLib.spawn_command_line_async for commands like:
systemctl start/stop openafs-clientsystemctl enable/disable openafs-clientaklogfor token handling
- GLib.spawn_async_with_pipes for securely handling password prompts via
kinit - St.Button, St.Label, PopupSwitchMenuItem for native GNOME-style UI elements
- Promises and async operations to keep UI non-blocking
gnome-shell-extension-openafs/
├── assets/
│ └── screenshot.png # UI preview image
├── icons/
│ ├── client-on.svg # Icon for active client status
│ └── client-off.svg # Icon for inactive client status
├── extension.js # Core logic of the extension, handles enable/disable
├── indicator.js # Indicator class for panel menu and UI logic
├── utils.js # Utility functions for checking client and token status
├── eslint.config.js # ESLint configuration based on GJS style guide
├── package.json # npm package for development tools (e.g., ESLint)
├── metadata.json # Extension metadata
├── stylesheet.css # Optional styles
└── README.md # Project documentation
Follow these steps to install and test the extension locally:
git clone https://github.com/ts-31/gnome-shell-extension-openafs.git
cd gnome-shell-extension-openafsGNOME extensions should be placed in a specific folder:
mkdir -p ~/.local/share/gnome-shell/extensions/[email protected]
cp -v -r * ~/.local/share/gnome-shell/extensions/[email protected]/- X11 session: Press
Alt + F2, typer, and press Enter. (Recommended) - Wayland session: Log out and log back in.
Use GNOME Extensions App (GUI) or terminal:
gnome-extensions enable "[email protected]"Click the top bar icon labeled “OpenAFS Status”.
Then from the terminal, toggle the client status:
sudo systemctl start openafs-client
# → Extension should show "Client: Running (cell: example.com)" if a cell is configured
# → If no cell is available, it will show "Client: Running (cell: not available)"
sudo systemctl start openafs-client
# → Click extension icon → Should show "Client: Running"
# Test autostart toggle
sudo systemctl disable openafs-client
# → Click extension icon → Toggle "Autostart on Boot" should be off
sudo systemctl enable openafs-client
# → Click extension icon → Toggle "Autostart on Boot" should be onThis project uses ESLint with the GJS-recommended configuration for code quality.
npm install npm run lint- Project: GNOME Shell Extension for OpenAFS
- Mentors: Mike Meffie, Gaurav Saxena
- Student: Tejas Sonawane
- Organization: OpenAFS
- Program: Google Summer of Code 2025
This extension is in active development as part of GSoC 2025. Contributions, suggestions, and feedback are welcome via issues and pull requests.
To the OpenAFS team and GNOME community for building incredible open infrastructure for decades.
"Bridging CLI power with GUI ease for OpenAFS users." — GSoC 2025 Student Developer
Shows the OpenAFS status menu with Start/Stop client options, a toggle switch for enabling/disabling autostart on boot, token status, and client status.