GUIDES
Setting Up Your Local Documentation
Easily set up the documentation on your machine with these straightforward steps:
- Clone the Repository: Start by cloning the repository to your local machine using this command:
git clone https://github.com/Raspirus/docs.git
- Install Python Dependencies:
Navigate to the project directory and install the necessary Python dependencies from the
requirements.txt
file using this command:
pip install -r requirements.txt
- Launch the Project Locally: Begin your local project by executing this command:
mkdocs serve
This will initiate a development server, allowing you to access the documentation via http://localhost:8000 in your preferred web browser.
Exporting Documentation to PDF
If you prefer an offline PDF version of this documentation, follow these step-by-step instructions:
-
Follow the setup process outlined above.
-
Build the Documentation: Employ mkdocs and use the build command:
mkdocs build
. -
Access the PDF: If the process goes smoothly, locate the resulting PDF file named
document.pdf
within thesite/pdf
directory.
Please note that the exported PDF may display minor issues with images and iFrames. Nevertheless, the text remains legible and suitable for offline sharing.
Introducing Translations
For translations of this documentation, visit Crowdin, a collaborative platform. Translations for UI strings are managed through JSON files. To contribute, craft your translations within the locales folder. Retain the uniqueness of keys when translating from the en.json
file.
Scanner Insights
Scanning Compressed Files
Note
This option is not yet available for the Raspberry Pi. see why in the FAQ section
While Raspirus defaults to scanning folders, you can alter this behavior via the settings page. By toggling a switch, you can scan individual files, including compressed ones. It's important to note that only one file can be scanned at a time.
Navigating Logs and Configurations
In the event of unexpected occurrences or sudden app crashes, examining logs and configurations can provide insights. Locate these files in the following folders, based on your operating system. The ProjectDirs crate stores them at the following location:
Config file:
Platform | Value | Example |
---|---|---|
Linux | $XDG_DATA_HOME /_project_path_ or $HOME /.local/share/_project_path_ |
/home/alice/.local/share/barapp |
macOS | $HOME /Library/Application Support/_project_path_ |
/Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App |
Windows | {FOLDERID_RoamingAppData} \_project_path_ \data |
C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\data |
Log files:
Platform | Value | Example |
---|---|---|
Linux | $XDG_DATA_HOME /_project_path_ or $HOME /.local/share/_project_path_ |
/home/alice/.local/share/barapp |
macOS | $HOME /Library/Application Support/_project_path_ |
/Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App |
Windows | {FOLDERID_LocalAppData} \_project_path_ \data |
C:\Users\Alice\AppData\Local\Foo Corp\Bar App\data |
Ensure to include these files when reporting bugs, as they greatly assist in troubleshooting.
Enriching the Signature Database
Raspirus has its own signatures repository which are collected from various sources and updated approximately once or twice every month. You can check out all the signatures there and report false positives or missing signatures directly there by opening an issue or Pull request. If you want to build your own signatures database, you can use the signature-builder.
Raspberry Pi Deployment
Originally tailored for standalone Raspberry Pi deployment with touchscreen functionality (akin to kiosk mode), this project's primary purpose was scanning attached USB drives. While the project's scope has expanded, this feature remains intact. Follow the guide on Tauri and if you encounter any issue with it, make sure to let us know. We also provide pre-built executables on our website!
Thank you for choosing Raspirus as your malware protection solution. These comprehensive guides will ensure your experience is seamless and efficient.