TudbuT/conduit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Turn README.Debian into a markdown file

Browse source 
It is common to have a markdown file per deployment subdirectory.
Still install it as `README.Debian` to `/usr/share/doc/matrix-conduit`
as per Debian policy.

Also update the link in the main `README.md` file.
This commit is contained in:
Paul van Tilburg 2023-07-23 12:24:37 +02:00
parent 8cf408e966
commit 433dad6ac2
No known key found for this signature in database
GPG key ID: C6DE073EDA9EEC4D
3 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -137,7 +137,7 @@ instead of a server that has high scalability."""
section = "net" section = "net"
priority = "optional" priority = "optional"
assets = [ assets = [
["debian/README.Debian", "usr/share/doc/matrix-conduit/", "644"], ["debian/README.md", "usr/share/doc/matrix-conduit/README.Debian", "644"],
["README.md", "usr/share/doc/matrix-conduit/", "644"], ["README.md", "usr/share/doc/matrix-conduit/", "644"],
["target/release/conduit", "usr/sbin/matrix-conduit", "755"], ["target/release/conduit", "usr/sbin/matrix-conduit", "755"],
] ]

2
README.md
View file

@ -39,7 +39,7 @@ Check out the [Conduit 1.0 Release Milestone](https://gitlab.com/famedly/conduit
#### How can I deploy my own? #### How can I deploy my own?
- Simple install (this was tested the most): [DEPLOY.md](DEPLOY.md) - Simple install (this was tested the most): [DEPLOY.md](DEPLOY.md)
- Debian package: [debian/README.Debian](debian/README.Debian) - Debian package: [debian/README.md](debian/README.md)
- Nix/NixOS: [nix/README.md](nix/README.md) - Nix/NixOS: [nix/README.md](nix/README.md)
- Docker: [docker/README.md](docker/README.md) - Docker: [docker/README.md](docker/README.md)

10
debian/README.Debian → debian/README.md vendored
View file

@ -6,23 +6,23 @@ Configuration
When installed, Debconf generates the configuration of the homeserver When installed, Debconf generates the configuration of the homeserver
(host)name, the address and port it listens on. This configuration ends up in (host)name, the address and port it listens on. This configuration ends up in
/etc/matrix-conduit/conduit.toml. `/etc/matrix-conduit/conduit.toml`.
You can tweak more detailed settings by uncommenting and setting the variables You can tweak more detailed settings by uncommenting and setting the variables
in /etc/matrix-conduit/conduit.toml. This involves settings such as the maximum in `/etc/matrix-conduit/conduit.toml`. This involves settings such as the maximum
file size for download/upload, enabling federation, etc. file size for download/upload, enabling federation, etc.
Running Running
------- -------
The package uses the matrix-conduit.service systemd unit file to start and The package uses the `matrix-conduit.service` systemd unit file to start and
stop Conduit. It loads the configuration file mentioned above to set up the stop Conduit. It loads the configuration file mentioned above to set up the
environment before running the server. environment before running the server.
This package assumes by default that Conduit will be placed behind a reverse This package assumes by default that Conduit will be placed behind a reverse
proxy such as Apache or nginx. This default deployment entails just listening proxy such as Apache or nginx. This default deployment entails just listening
on 127.0.0.1 and the free port 6167 and is reachable via a client using the URL on `127.0.0.1` and the free port `6167` and is reachable via a client using the URL
http://localhost:6167. <http://localhost:6167>.
At a later stage this packaging may support also setting up TLS and running At a later stage this packaging may support also setting up TLS and running
stand-alone. In this case, however, you need to set up some certificates and stand-alone. In this case, however, you need to set up some certificates and