1
0
mirror of https://github.com/gophernicus/gophernicus.git synced 2024-11-03 04:27:17 -05:00

replace executable name, remove trailing spaces

This commit is contained in:
Yargo 2019-06-24 15:33:16 +00:00 committed by fosslinux
parent efdea56b8e
commit 5d23cabd65
17 changed files with 70 additions and 70 deletions

1
.gitignore vendored
View File

@ -4,6 +4,7 @@
*.o
files.h
functions.h
README
README.options
bin2c
gophernicus

View File

@ -14,11 +14,19 @@ $ make
$ sudo make install
```
after having set the correct public hostname in the `gophernicus.env`
file. If this is wrong, selectors ("gopher links") won't work!
On \*nix systems, `hostname` might give you an idea, but please
note this might be completely wrong, especially on your personal
machine at home or on some cheap virtual server. If you know you
have a fixed numerical IP, you can also directly use that.
For testing, just keep the default value of `localhost` which will
result in selectors working only when you're connecting locally.
That's it - Gophernicus should now be installed, preconfigured
and running under gopher://<HOSTNAME>/. And more often than not,
It Just Works(tm). If gopher links don't seem to work you may
need to configure your public hostname explicitly in whatever
config file Gophernicus is using.
It Just Works(tm).
By default Gophernicus serves gopher documents from `/var/gopher`
although that can be changed by using the `-r <root>` parameter.
@ -28,49 +36,43 @@ hostname (the one set with `-h <hostname>`) directory available
(`mkdir /var/gopher/$HOSTNAME`).
<<<<<<< HEAD:INSTALL
Dependencies
============
## Dependencies
These were obtained from a base docker installation, what we
(will) be using on Travis.
# Ubuntu 18.04, 16.04, Debian Sid, Buster, Stretch, Jessie #
### Ubuntu 18.04, 16.04, Debian Sid, Buster, Stretch, Jessie
- build-essential
- git
- libwrap0-dev for tcp
# Centos 6, 7 #
### Centos 6, 7
- the group 'Development Tools'. less is probably required, but
I know this works and couldn't be bothered to find out what was
actually required.
# Fedora 29, 30, rawhide #
### Fedora 29, 30, rawhide
- the group 'Development Tools'. less is probably required, but
I know this works and couldn't be bothered to find out what was
actually required.
- net-tools
# OpenSuse Leap, Tumbleweed #
### OpenSuse Leap, Tumbleweed
- the pattern devel_C_C++
- the pattern devel_basis
- git
# archlinux #
### archlinux
- base-devel
- git
# Gentoo #
### Gentoo
- git
# Alpine Linux #
### Alpine Linux
- alpine-sdk. once again, less is probably required.. blah blah.
Other installation targets
==========================
=======
## Other installation targets
>>>>>>> 82a1abebc4bfabc43ef6b27f0627f526984eaf30:INSTALL.md
### Other installation targets
Suppose your server runs systemd, but you'd rather have Gophernicus
started with inetd or xinetd. To do that, do `make install-inetd`
@ -90,7 +92,7 @@ just run 'make withwrap'.
For configuring IP access lists with TCP wrappers, take a look
at the files `/etc/hosts.allow` and `/etc/hosts.deny` (because the
manual pages suck). Use the daemon name 'gophernicus' to
manual pages suck). Use the daemon name "gophernicus" to
make your access lists.
@ -134,9 +136,7 @@ arch one.
$ make HOSTCC=gcc CC=target-arch-gcc
```
## Shared memory issues
====================
Gophernicus uses SYSV shared memory for session tracking and
statistics. It creates the shared memory block using mode 600
@ -156,17 +156,14 @@ $ sudo make clean-shm
## Porting to different platforms
If you need to port Gophernicus to a new platform, please take
a look at gophernicus.h which has a bunch of `HAVE_*` `#defines`.
Fiddling with those usually makes it possible to compile a working
server. If you succeed in compiling Gophernicus to a new
platform please send the patches to
<gophernicus at gophernicus dot org> so we can include them into
the next release.
If you need to port Gophernicus to a new platform, please take a look at
gophernicus.h which has a bunch of `#define HAVE_...` Fiddling with those
usually makes it possible to compile a working server.
If you succeed in compiling Gophernicus to a new platform please send
the patches to <gophernicus at gophernicus dot org> so we can include
them into the next release.
<<<<<<< HEAD:INSTALL
Supported Platforms
===================
## Supported Platforms
| Platform | Versions |
| ------------ | ---------------------------- |
@ -178,5 +175,4 @@ Supported Platforms
| Arch Linux | up to date |
| Gentoo | up to date |
| Alpine Linux | Edge, 3.9 |
=======
>>>>>>> 82a1abebc4bfabc43ef6b27f0627f526984eaf30:INSTALL.md
| FreeBSD | 12.0 |

View File

@ -5,15 +5,18 @@
3.0
## Changelog
<!--- this should be mirrored from Changelog -->
### 3.0 (from 101):
**N.B. this version has two important changes that may make it backwards-incompatible:**
* binary changed from in.gophernicus to gophernicus
* virtual hosting NEVER WORKED and does not work in the way previously
described
Other changes:
**N.B. this version has two important changes that may make it backwards-incompatible:**
* binary changed from in.gophernicus to gophernicus
* virtual hosting NEVER WORKED and does not work in the way previously described
#### Other changes:
* prevent leak of executable gophermap contents
* make sure {x,}inetd works when systemd is on the system
* allow -j flag to work
@ -31,10 +34,10 @@ Other changes:
* add travis ci
* add documentation about CI
Upgrade guide:
#### Upgrade guide:
If you are running gophernicus on a **production** system, **do not** upgrade
to 3.0. Wait for 3.1.
If you are running gophernicus on a **production** system, **do not** upgrade to 3.0.
Wait for 3.1.
As a general guide:

View File

@ -1,13 +1,13 @@
3.0 (from 101)
==============
N.B. this version has two important changes that may make it
backwards-incompatible:
N.B. this version has two important changes that may make it backwards-incompatible:
* binary changed from in.gophernicus to gophernicus
* virtual hosting NEVER WORKED and does not work in the way previously
described
* virtual hosting NEVER WORKED and does not work in the way previously described
Other changes:
* prevent leak of executable gophermap contents
* make sure {x,}inetd works when systemd is on the system
* allow -j flag to work
@ -27,10 +27,10 @@ Other changes:
Upgrade guide:
If you are running gophernicus on a **production** system, **do not** upgrade
to 3.0. Wait for 3.1.
If you are running gophernicus on a **production** system, **do not** upgrade to 3.0.
Wait for 3.1.
As a general guide,
As a general guide:
If you are running 101 and haven't upgraded to newer versions **because** of
instability worries, **wait for 3.1**.