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 pull request. "Installation and Usage" #404

Open
Squelch opened this issue Jul 16, 2024 · 4 comments
Open

Documentation pull request. "Installation and Usage" #404

Squelch opened this issue Jul 16, 2024 · 4 comments

Comments

@Squelch
Copy link

Squelch commented Jul 16, 2024

I have made some revisions to the Installation and Usage wiki page to clear up a few ambiguities and misunderstandings that seem to have occured. I have also elaborated of some other instructions to clarify login details.

Please see the revisions on my clone of the wiki:
https://github.com/Squelch/factorio-server-manager/wiki/Installation-and-Usage

@Mattie112
Copy link
Contributor

Mattie112 commented Jul 16, 2024

Visit localhost:8080 in your web browser.

Perhaps change to:
Visit http://localhost:8080 in your web browser.

(And also: is the port correct? Earlier we are binding port 80 to port 80)

Perhaps it would also be best to use a volume mapping in the first example. Or at least refer to where your saves etc are stored to prevent people from losing them. Or at least hint to the more elaborate docker instructions at https://github.com/OpenFactorioServerManager/factorio-server-manager/tree/develop/docker#readme

I would also suggest to add somekind of FAQ (#389) to at least address the "I forgot my password" part :)

Other then that: looks good to me!

edit: my comment about the ports mismatches docker and linux/windows, nevertheless the port is 80, not 8080
https://github.com/OpenFactorioServerManager/factorio-server-manager/blob/develop/src/bootstrap/config.go#L23

@Squelch
Copy link
Author

Squelch commented Jul 16, 2024

The port number is indeed inconsistent between platforms, and is intended to be the subject of a future issue.

A docker map would be useful, and my thought was it could be added to a Docker specific page for those that need it, and some basic commands for those that are not expert with using rather than developing on Docker. There's a few other inconsistencies with how the Docker image performs compared to other platforms that might need addressing or documenting too.

I have also been contemplating adding a Password heading to the page to recap the instructions on where to find the initial password, and what to do when the password is lost. Thanks for confirming my thoughts there.

These revisions are an inital start to make some clarifications and avoid confusion in the first instance. Further expansion of the documentation overall would be nice, but it is probably prudent to wait until 1.1 is close to include new features and changes.

I do not have edit rights on this wiki, hence the need to have cloned it and make edits on my own copy. All revisions I've made are commented, so it would be possible to either merge the repos, or simply copy/paste from the history where required. I will continue to develope further pages on my copy in the meantime as work in progress. I would invite anyone wishing to collaborate to join me.

@Mattie112
Copy link
Contributor

Yeah it is a bit strange that you cannot make a PR for the wiki in github.... Would make it easier to change some smaller things.

But nice work at least starting with it ;)

@Squelch
Copy link
Author

Squelch commented Jul 16, 2024

Further revisions made to incorporate suggestions made by @Mattie112

  1. Link to further Docker image information
  2. Login and Password section added
  3. Subsection detailing login recovery
  4. Added note that Factorio Server is included in the docker container

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants