|
|
@@ -5,27 +5,27 @@ IndieWeb specifications natively.
|
|
5
|
5
|
- All content is exposed using standard [microformats2][] markup, making it
|
|
6
|
6
|
easy for other sites and applications across the IndieWeb to consume.
|
|
7
|
7
|
- Additionally, the site owner's profiles are exposed using [rel-me][],
|
|
8
|
|
- enabling independent verification of their identity across various services.
|
|
9
|
|
- This permits [IndieAuth.com][] to authenticate the site's owner using a
|
|
10
|
|
- social profile, such as a Twitter account. However, this functionality is not
|
|
11
|
|
- necessary because lemoncurry also fully implements…
|
|
|
8
|
+ enabling independent verification of their identity across various services.
|
|
|
9
|
+ This permits [IndieAuth.com][] to authenticate the site's owner using a
|
|
|
10
|
+ social profile, such as a Twitter account. However, this functionality is not
|
|
|
11
|
+ necessary because lemoncurry also fully implements…
|
|
12
|
12
|
- [IndieAuth][], an protocol derived from OAuth 2.0 which enables the site's
|
|
13
|
|
- owner to authorise access to their domain directly from the lemoncurry site
|
|
14
|
|
- itself. Additionally, tokens for further access to the lemoncurry site may be
|
|
15
|
|
- requested and issued, including customisable token scope as in OAuth.
|
|
|
13
|
+ owner to authorise access to their domain directly from the lemoncurry site
|
|
|
14
|
+ itself. Additionally, tokens for further access to the lemoncurry site may be
|
|
|
15
|
+ requested and issued, including customisable token scope as in OAuth.
|
|
16
|
16
|
- [Micropub][] is *partially* supported - using a token obtained through
|
|
17
|
|
- IndieAuth, clients may post new content to the lemoncurry site using either
|
|
18
|
|
- the form-encoded or JSON request formats. There is currently no support for
|
|
19
|
|
- updating or deleting existing content through Micropub, although this is of
|
|
20
|
|
- course planned.
|
|
|
17
|
+ IndieAuth, clients may post new content to the lemoncurry site using either
|
|
|
18
|
+ the form-encoded or JSON request formats. There is currently no support for
|
|
|
19
|
+ updating or deleting existing content through Micropub, although this is of
|
|
|
20
|
+ course planned.
|
|
21
|
21
|
- [Webmention][], used to enable rich commenting and social interaction between
|
|
22
|
|
- separate IndieWeb sites, is partially supported. lemoncurry will correctly
|
|
23
|
|
- *send* webmentions to all URLs mentioned in a published entry. However, it
|
|
24
|
|
- currently does not expose an endpoint for *receiving* webmentions.
|
|
|
22
|
+ separate IndieWeb sites, is partially supported. lemoncurry will correctly
|
|
|
23
|
+ *send* webmentions to all URLs mentioned in a published entry. However, it
|
|
|
24
|
+ currently does not expose an endpoint for *receiving* webmentions.
|
|
25
|
25
|
- [WebSub][] is also partially supported. When content is posted through
|
|
26
|
|
- Micropub, WebSub is pinged as it should be - however, since only creating
|
|
27
|
|
- *new* content through Micropub is supported, updates do not currently cause a
|
|
28
|
|
- WebSub ping.
|
|
|
26
|
+ Micropub, WebSub is pinged as it should be - however, since only creating
|
|
|
27
|
+ *new* content through Micropub is supported, updates do not currently cause a
|
|
|
28
|
+ WebSub ping.
|
|
29
|
29
|
|
|
30
|
30
|
[IndieAuth]: https://www.w3.org/TR/indieauth/
|
|
31
|
31
|
[IndieAuth.com]: https://indieauth.com/
|
|
|
@@ -47,8 +47,8 @@ As well as the following services:
|
|
47
|
47
|
|
|
48
|
48
|
* [PostgreSQL][] - create a database named `lemoncurry`. Socket auth is
|
|
49
|
49
|
recommended, so ensure the UNIX user you'll be running lemoncurry with has
|
|
50
|
|
- access to that database. Alternatively, set the `POSTGRES_PASSWORD`
|
|
51
|
|
- environment variable to use password auth.
|
|
|
50
|
+ access to that database. Alternatively, set the `POSTGRES_PASSWORD`
|
|
|
51
|
+ environment variable to use password auth.
|
|
52
|
52
|
* [Redis][] - lemoncurry expects to find Redis on port 6380, rather than the
|
|
53
|
53
|
standard port of 6379. Sorry about that.
|
|
54
|
54
|
|
|
|
@@ -56,7 +56,7 @@ If you're running in production, I'd recommend [Gunicorn][], which is already pa
|
|
56
|
56
|
of lemoncurry's Pipfile. Ensure you run Gunicorn behind a secure reverse proxy,
|
|
57
|
57
|
such as [Nginx][].
|
|
58
|
58
|
|
|
59
|
|
-If you're running in development, the usual Django `run_server` command should
|
|
|
59
|
+If you're running in development, the usual Django `runserver` command should
|
|
60
|
60
|
be fine.
|
|
61
|
61
|
|
|
62
|
62
|
[Gunicorn]: https://gunicorn.org/
|
|
|
@@ -68,12 +68,13 @@ be fine.
|
|
68
|
68
|
|
|
69
|
69
|
# Installation
|
|
70
|
70
|
|
|
71
|
|
-Clone the repo, and then install both Python and Node dependencies:
|
|
|
71
|
+Clone the repo recursively - since it uses Git submodules - and then install
|
|
|
72
|
+both Python and Node dependencies.
|
|
72
|
73
|
|
|
73
|
74
|
```shellsession
|
|
74
|
|
-$ git clone https://git.00dani.me/00dani/lemoncurry
|
|
|
75
|
+$ git clone --recursive https://git.00dani.me/00dani/lemoncurry
|
|
75
|
76
|
$ cd lemoncurry
|
|
76
|
|
-$ pipenv install
|
|
|
77
|
+$ pipenv install --dev
|
|
77
|
78
|
$ yarn install
|
|
78
|
79
|
```
|
|
79
|
80
|
|
