Skip to content

Commit 70ca578

Browse files
committed
Update readme links to wiki
1 parent a499cea commit 70ca578

File tree

1 file changed

+2
-156
lines changed

1 file changed

+2
-156
lines changed

README.md

Lines changed: 2 additions & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -14,71 +14,7 @@ This tool runs on a Factorio server and allows management of the Factorio server
1414
* Authentication for protecting against unauthorized users
1515
* Available as a Docker container
1616

17-
## Installation Docker
18-
1. Pull the Docker container from Docker Hub using the pull command
19-
```
20-
docker pull ofsm/ofsm:latest
21-
```
22-
23-
2. Now you can start the container by running:
24-
```
25-
docker run --name ofsm -d -p 80:80 -p 34197:34197/udp ofsm/ofsm:latest
26-
```
27-
28-
## Installation Linux
29-
1. Download the latest release
30-
* [https://github.com/OpenFactorioServerManager/factorio-server-manager/releases](https://github.com/OpenFactorioServerManager/factorio-server-manager/releases)
31-
2. Download the Factorio Standalone server and install to a known directory.
32-
3. Run the server binary file, use the --dir flag to point the management server to your Factorio installation. If you are using the steam installation, point FSM to the steam directory.
33-
* ```./factorio-server-manager --dir /home/user/.factorio ```
34-
* ```./factorio-server-manager --dir /home/user/.steam/steam/steamapps/common/Factorio ```
35-
4. Visit [localhost:8080](localhost:8080) in your web browser.
36-
37-
## Installation Windows
38-
1. Download the latest release
39-
* [https://github.com/OpenFactorioServerManager/factorio-server-manager/releases](https://github.com/OpenFactorioServerManager/factorio-server-manager/releases)
40-
2. Download the Factorio Standalone server and install to a known directory.
41-
3. Run the server binary file via cmd or Powershell, use the --dir flag to point the management server to your Factorio installation.
42-
* ```.\factorio-server-manager --dir C:/Users/username/Factorio```
43-
4. Visit [localhost:8080](localhost:8080) in your web browser.
44-
45-
## Usage
46-
Run the UI server and specify the directory of your Factorio server installation and the interface to run the HTTP server on. Edit the conf.json file with your desired credentials for authentication.
47-
```
48-
Usage of ./factorio-server-manager:
49-
-bin string
50-
Location of Factorio Server binary file (default "bin/x64/factorio")
51-
-conf string
52-
Specify location of Factorio Server Manager config file. (default "./conf.json")
53-
-config string
54-
Specify location of Factorio config.ini file (default "config/config.ini")
55-
-dir string
56-
Specify location of Factorio directory. (default "./")
57-
-host string
58-
Specify IP for webserver to listen on. (default "0.0.0.0")
59-
-max-upload int
60-
Maximum filesize for uploaded files (default 20MB). (default 20971520)
61-
-port string
62-
Specify a port for the server. (default "8080")
63-
-glibc-custom string
64-
Specify if custom glibc is used (default false) [true/false]
65-
-glibc-loc string
66-
Path to the glibc ld.so file (default "/opt/glibc-2.18/lib/ld-2.18.so")
67-
-glibc-lib-loc
68-
Path to the glibc lib folder (default "/opt/glibc-2.18/lib")
69-
-autostart
70-
Autostarts Factorio Server when FSM is starting. Default false [true/false]
71-
(If no IP and/or port provided at startup, it will bind the factorio server to all interfaces
72-
and set the server port to the default 34197, always loads latest save)
73-
Example:
74-
75-
./factorio-server-manager --dir /home/user/.factorio --host 10.0.0.1
76-
77-
Custom glibc example:
78-
79-
./factorio-server-manager --dir /home/user/.factorio --host 10.0.0.1 --glibc-custom true --glibc-loc /opt/glibc-2.18/lib/ld-2.18.so --glibc-lib-loc /opt/glibc-2.18/lib
80-
81-
```
17+
## [Installation and Usage](https://github.com/OpenFactorioServerManager/factorio-server-manager/wiki/Installation-and-Usage)
8218

8319
## Manage Factorio Server
8420
![Factorio Server Manager Screenshot](screenshots/Screenshot_Controls.png)
@@ -89,97 +25,7 @@ Custom glibc example:
8925
## Manage mods
9026
![Factorio Server Manager Screenshot](screenshots/Screenshot_Mods.png)
9127

92-
93-
94-
## Development
95-
The backend is built as a REST API via the Go web application.
96-
97-
It also acts as the webserver to serve the front end react application
98-
99-
All api actions are accessible with the /api route. The frontend is accessible from /.
100-
101-
### API Auth
102-
103-
To authenticate with the API and get access to its functionality, you need to login first.
104-
105-
Here is a small example showing how to do it with a local install using default credentials, via the tool curl:
106-
```
107-
curl --cookie-jar cookie.txt --insecure --data '{"username":"admin","password":"factorio"}' -H "Content-Type: application/json" -X POST https://localhost/api/login
108-
curl --cookie cookie.txt --insecure https://localhost/api/server/status
109-
```
110-
111-
#### Requirements
112-
+ Go 1.11
113-
+ NodeJS >10.13.0
114-
115-
#### Building Releases
116-
Creates a release zip for windows and linux: (this will install the dependencies listed in gopkgdeps)
117-
```
118-
git clone [email protected]:OpenFactorioServerManager/factorio-server-manager.git
119-
cd factorio-server-manager
120-
make gen_release
121-
```
122-
123-
#### Building a Testing Binary:
124-
```
125-
git clone [email protected]:OpenFactorioServerManager/factorio-server-manager.git
126-
cd factorio-server-manager
127-
make
128-
./factorio-server-manager/factorio-server-manager
129-
```
130-
131-
#### Building the React Frontend alone
132-
Frontend is built using React and the AdminLTE CSS framework.
133-
134-
The root of the UI application is served at app/index.html. Run the npm build script and the Go application during development to get live rebuilding of the UI code.
135-
136-
All necessary CSS and Javascript files are included for running the UI.
137-
138-
Transpiled bundle.js application is output to app/bundle.js, 'npm run build' script starts webpack to build the React application for development.
139-
```
140-
make app/bundle
141-
```
142-
143-
##### For development
144-
The frontend is completely build by npm with laravel-mix. All plugins are build into the compiled files. No plugins need to be load fro external sources.
145-
146-
It has different variants to build the frontend, provided by laravel-mix:
147-
- `npm run dev` Build the code for development. This will also generate map-files, so the browser, can show, what line and file causes the output.
148-
- `npm run watch` Build the code for development like the dev-command. This will not stop and automatically rebuild, when files are changed and saved.
149-
- `npm run hot` Build the code for development. It has the same behaviour like the watch-command and also causes a hotReload of the files inside the browser (in theory)
150-
- `npm run build` Build the code for deployment. It will generate no map-files and also minifies the bundle-files.
151-
In every of those cases, also images and fonts will be copied to the app-folder.
152-
153-
### Building for Windows
154-
1. Download the latest release source zip file
155-
* [https://github.com/OpenFactorioServerManager/factorio-server-manager/releases](https://github.com/OpenFactorioServerManager/factorio-server-manager/releases)
156-
2. Unzip the Factorio Standalone server and move it to a known directory.
157-
3. Download and install Go 1.11 or newer. https://golang.org/dl/
158-
4. Download and install NodeJS 64-bit or 32-bit depending on your operating system, most users need 64-bit nowadays.
159-
* https://nodejs.org/dist/v12.13.0/node-v12.13.0-x64.msi 64-bit
160-
* https://nodejs.org/dist/v12.13.0/node-v12.13.0-x86.msi 32-bit
161-
162-
Once everything is installed and ready to go you will need to compile the source for windows
163-
164-
1. Open the folder where ever you unzipped from step #2 above.
165-
2. My folder structure is like this "C:\FS\factorio-server-manager\" C:\FS is where my factorio files are located C:\FS\factorio-server-manager\ is where the server manager files are.
166-
3. Now you will want to go into the src folder for example "C:\FS\factorio-server-manager\src" once there hold down shift and right click an empty area of the folder. Then click "Open command windows here"
167-
4. Type this into the command prompt then hit enter:
168-
169-
```
170-
go build
171-
```
172-
173-
5. Once finished you will now see src.exe or src file inside the folder. You need to move that file to the C:\FS\factorio-server-manager\ or the folder that is before your src folder.
174-
6. From here you need to build the web front-end. Again hold shift and right click in an empty area then select open command prompt here. You then need to type this:
175-
176-
```
177-
npm install
178-
npm run build
179-
```
180-
181-
7. Now execute the src file created in step #4 above. You have to specify the directory, where the factorio-server is located, as parameter. More about the parameter under [Usage](#Usage)
182-
8. You can now Visit [localhost:8080](localhost:8080) in your web browser to start using the Factorio server Manager
28+
## [Development](https://github.com/OpenFactorioServerManager/factorio-server-manager/wiki/Developmen)
18329

18430
## Contributing
18531
1. Fork it!

0 commit comments

Comments
 (0)