File: README.md

package info (click to toggle)
ldh-gui-suite 0.1~20190927-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 360 kB
  • sloc: makefile: 77; sh: 62; perl: 49
file content (152 lines) | stat: -rw-r--r-- 3,728 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
LDH GUI Suite
=============

[project] | [code] | [tracker]

A Liberty Deckplan Host (LDH) is a single domain implementing the concrete
configuration plan defined at <https://source.puri.sm/liberty/services>

This package contains resources for LDH clients. Including:

* icons for all services and wrappers for web interfaces
* default configuration for the flagship host `librem.one`
* reconfiguration for any other host

Install
-------

If the GUI Suite is not pre-installed on your system, the preferred
installation method is your package manager. Installing the suite
package will install all recommended clients and their dependencies on
your system.

### Debian

Requirements:

* GNOME Web (a.k.a. Epiphany) 3.19.1 or newer

<!-- TODO: actually release package for Debian

On Debian and derived systems (including Ubuntu and PureOS):

```
sudo apt install ldh-social-gui
```

-->

### From source tarball

Build requirements when installing from source:

* make
* scour
* rsvg-convert
* gtk-update-icon-cache

Installing from source tarball:

```
./configure
make
sudo make install
```

### From Git snapshot

Additional build requirements when installing from Git snapshot:

* autoconf 2.69 or newer
* autoconf-archive 2015-02-05 or newer
* automake

Installing from Git snapshot:

```
./bootstrap
./configure
make
sudo make install
```

Configuration
-------------

Consult your distribution how to configure when installing a package.

When installing from source, you can customize which Liberty Deckplan
Host to use, by passing the `--enable-domain=DOMAIN` option to
configure.

Alternatively you can freely define the full URIs to use, by passing
the `--enable-hub-uri=URI` and/or `--enable-social-uri=URI` options to
configure.

Usage
-----

### Hub

* Click on the Hub icon to launch.
* Enter your credentials.
* Manage your account.

### Social

* Click on the Social icon to launch.
* Enter your credentials.
* Start posting!

Implementation
--------------

Web wrappers are currently implemented as a GNOME Web applications,
configured by debconf. See
[How do I define a system-wide web application?](http://wiki.gnome.org/Apps/Web/Docs/FrequentlyAskedQuestions#How_do_I_define_a_system-wide_web_application.3F)
(GNOME Web FAQ) for details.

This implementation should work on any Debian-based distribution that
includes GNOME Web.

Host compatibility
------------------

Clients should work with on any host that follows the Liberty Deckplan.
For example, any social server with the domain `social.example.com`
and which supports `/web/getting-started` as a login path. The latter
includes any Smilodon, Mastodon or Florence instance.

Sharing and contributions
-------------------------

LDH GUI Suite  
<https://source.puri.sm/liberty/ldh_gui_suite>  
Copyright 2019 Purism SPC  
SPDX-License-Identifier: AGPL-3.0-or-later  

Shared under AGPL-3.0-or-later. We adhere to the Community Covenant
1.0 without modification, and certify origin per DCO 1.1 with a
signed-off-by line. Contributions under the same terms are
welcome.

For details see:

* [COPYING.AGPL.md], full license text
* [CODE_OF_CONDUCT.md], full conduct text
* [CONTRIBUTING.DCO.md], full origin text (`git -s`)

<!-- * [CONTRIBUTING.md], additional contribution notes -->

<!-- Links -->

[project]: https://source.puri.sm/liberty/ldh_gui_suite
[code]: https://source.puri.sm/liberty/ldh_gui_suite/tree/master
[tracker]: https://source.puri.sm/liberty/ldh_gui_suite/issues
[wiki]: https://source.puri.sm/liberty/ldh_gui_suite/wikis/home
[SETUP.md]: SETUP.md
[COPYING.AGPL.md]: COPYING.AGPL.md
[CODE_OF_CONDUCT.md]: CODE_OF_CONDUCT.md
[CONTRIBUTING.DCO.md]: CONTRIBUTING.DCO.md
[COPYING.md]: COPYING.md
[CONTRIBUTING.md]: CONTRIBUTING.md