mother/gns3-docs

gns3-docs's Issues

Broken Links

I found two broken links on the gns3 docs website. The last two links on the following page produce a 404 error. It looks like at least one of them may have been just moved so I'll take a look and probably propose a fix.

https://github.com/mother/gns3-docs/blob/master/docs/getting-started/installation/remote-server.md

Cannot list VMWare VMs with the "gns3" user

Hi,

I followed this tutorial to install gns3 on a remote Ubuntu 22.04 server : https://docs.gns3.com/docs/getting-started/installation/remote-server/. I also installed VMWare Workstation.

However, gns wasn't listing any of my VMs running in VMWare. After some time, I found that gns3server was ran by the "gns3" user (https://raw.githubusercontent.com/GNS3/gns3-server/master/scripts/remote-install.sh).

If I run gns3server with my main user, I can find my VMs in the list. I gave full RWX to gns3 user on my vmware folder, or even setup a shared vm folder with a dedicated user group, but it doesn't work. I also added the line "prefvmx.defaultvmpath" to "/etc/vmware/config" but still doesn't help.

As I don't really know how the gns3server is listing the VMs (api I guess), I can't provide a good fix, except running gns3 with my main user. Can you help me so that we can update the doc and write a procedure to setup the permissions ?

Thanks !

Can We Add GNS3 Installation Way from Fedora to GNS3 Docs?

Hello, I seen on https://fedoramagazine.org/using-gns3-with-fedora/

We can install gns3-server and gns3-gui from fedora default repo, could it be added to the docs? Is it open for MR/PR?

Related page : https://docs.gns3.com/docs/getting-started/installation/linux

Thank you

Docs update - Running the gns3 server as a deamon, systemd

https://github.com/mother/gns3-docs/blob/master/docs/using-gns3/administration/running-gns3-server-as-daemon.md

Recommend the following changes to the above files systemd portion. Specifically the following part.

You must copy gns3.service.systemd to /lib/systemd/system/gns3.service and run these commands:

sudo cp gns3.service.systemd /lib/systemd/system/gns3.service
sudo chown root /lib/systemd/system/gns3.service

This should instead be changed to the following, my reasoning follows.

You must copy gns3.service.systemd to /etc/systemd/system/gns3.service and run these commands:

sudo cp gns3.service.systemd /etc/systemd/system/gns3.service
sudo systemctl daemon-reload

/etc/systemd/system is the preferred location for "custom" or additional systemd unit files that are not installed as part of a package. In this case the gns3.service file is not installed via pip and is instead downloaded separately. This is not required.
The systemctl daemon-reload command is required after adding a systemd unit file in order for systemd to know that the file has been added. Without this command starting the service will not work.

Enable/add the ability to create/save and auto-add signatures for a user

[Enhancement]

Requesting the ability for users to create and save signatures for their profile. Once a signature is created for that profile, and new discussions, questions or responses be automatically added to the text input box for the body of the message. Cursor should be placed at least two lines above the signature within the edit box.

Debian based instructions mixed in with Arch based instructions

This section: https://docs.gns3.com/docs/getting-started/installation/linux#install-gns3-from-pypi, includes instructions for using apt. This section is a sub-section under the Arch instructions (not compatible) found here: https://docs.gns3.com/docs/getting-started/installation/linux#install-gns3-on-archlinux-based-

My guess is that the PyPi instructions were meant to have a different header type.

gns3 3.0 documentation

okay, I figured it out.
The gui documentation has to be largely based on the buttons in the gui.
The "two" easiest chapters are:
Projects
import project, and
export project;
Help
looking at gns3*.log
looking at virtualbox community pages
looking at vmware webpages

It will be very difficult to understand for a non-Microsoft Word user to understand, but the classes in VBA should be designed around the buttons. The big problem with Word is that the easiest to learn and the fastest to learn is to create code around the Editing button - Replace. It creates a total mess.

The documentation, save the install procedures, should be designed around, based upon, the gns3 developer buttons.

The installation documentation is somewhat different.
If you look at the gns3 python code, and the best example is the gns3 developers use a stopwatch of 120 seconds to verify the gns3 vm is online, the gns3 developers are verifying that some event (it is an Event and not a simple log entry - but that is another story), has occurred. That means the installation instructions must verify that the event has succeeded. That means that chapter of installation must include verification and those instructions must not be in the Help section.

I think that is good.

Edit: The Project Chapter does not exist in the gns3 documentation. But...there may be some kind of bug in the way gns3 projects are exported:
https://gns3.com/community/featured/error-while-exporting-a-projcet
I do not know what is going on with export project problems. It might be over my skill level.
But the chapter is wide open for the taking. I think I will take it.