Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Add Installation Guide for Windows Users #19

Open
Ansh5748 opened this issue Jan 2, 2025 · 2 comments
Open

[Documentation] Add Installation Guide for Windows Users #19

Ansh5748 opened this issue Jan 2, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Ansh5748
Copy link

Ansh5748 commented Jan 2, 2025

What happened

The official IntelOwl documentation does not include a dedicated installation guide for Windows users. This creates a challenge for users who want to run IntelOwl on Windows using WSL and Docker.

Environment

  1. OS: Windows 10/11 with WSL2
  2. IntelOwl version: Latest (at the time of raising this issue)

What did you expect to happen

I expected to find an installation guide for Windows users, detailing the steps to set up IntelOwl using WSL, Docker, and other dependencies.

How to reproduce your issue

  1. Visit the official IntelOwl documentation.
  2. Search for installation instructions for Windows users.
  3. Notice the absence of specific guidance for Windows setup.

Error messages and logs

No error messages are directly related to this issue. However, Windows users face difficulties due to the lack of proper guidance.

@Ansh5748 Ansh5748 added the bug Something isn't working label Jan 2, 2025
@Ansh5748
Copy link
Author

Ansh5748 commented Jan 2, 2025

Hi,

I would like to be assigned this issue as I have prepared a detailed solution to address the lack of a Windows-specific installation guide for IntelOwl.

Proposed Solution

I have created a comprehensive IntelOwl Installation Guide for Windows, which includes:
Detailed prerequisites for setting up the required tools like WSL, Docker, and Visual Studio Code.
Step-by-step instructions to configure WSL, Docker, and the IntelOwl project on a Windows machine.
Clear directions for creating a superuser and accessing the IntelOwl web interface.
A plan to include images (described below) to improve understanding.


Steps to Solve the Issue
Install and Set Up WSL (Windows Subsystem for Linux):
The guide includes steps to install and update WSL to create a Linux environment in Windows.

Install Docker and Docker Compose in WSL:

Users are guided through the process of installing Docker and Docker Compose to enable containerized deployments.

Clone and Configure IntelOwl:

Instructions are provided for cloning the IntelOwl repository, running the setup scripts, and starting the application in production mode.

Create a Superuser:

Steps to create a superuser are included to ensure access to the IntelOwl web interface.

Access IntelOwl via Browser:

Users will be directed on how to access the application from a browser using http://localhost.

Include Images:

I have add the following screenshots to enhance the guide for complete Window setup:
Screenshot 2025-01-02 154534
Screenshot 2025-01-02 154551
Screenshot 2025-01-02 154602


Thank you for considering my request to contribute to solving this issue!

@mlodic mlodic transferred this issue from intelowlproject/IntelOwl Jan 2, 2025
@mlodic
Copy link
Member

mlodic commented Jan 2, 2025

I moved this issue to the repository of the official documentation for the IntelOwl project.

We could try to find a space in the documentation for your work. However, I would like to explicitly underline how Windows is not officially supported and won't ever be officially supported. Adding documentation regarding how to install IntelOwl in Windows could be still useful for certain users but should not be highlighted much cause it is not be part of our plans and won't ever be

@fgibertoni fgibertoni added documentation Improvements or additions to documentation enhancement New feature or request and removed bug Something isn't working labels Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants