Commit Graph
83 Commits
Author SHA1 Message Date
Pavel MineevandUmputun 6fe373d540 fix: update fe contributing documentation and get dev commands in order 2022-11-30 01:19:51 -06:00
Denis HananeinandUmputun 984fbde540 Support no_footer option 2022-10-25 21:42:08 -05:00
Dmitry VerkhoturovandUmputun d2ea572abf fix "it's" used in place of "its" 2022-10-20 14:18:21 -05:00
Dmitry VerkhoturovandUmputun cebe929118 bump go modules, enable LoginAuth option for email
That option is needed for outlook.com and Office 365, resolves #1472.
2022-10-03 03:26:34 -05:00
Dmitry VerkhoturovandUmputun 3eccf01f1f bump docker-compose.yml for the site to work with dev properly
Previously, an image built for the `build` service was then used
for `server`, and changes were invisible to the user
before the container rebuild.

After that change, the useless static `build` service is deleted,
Dockerfile is only used in the CI pipeline, and only the `server`
service is left in docker-compose for the user to test
and see documentation changes locally in real-time.

Resolves #1178
2022-10-02 23:52:19 -05:00
Dmitry VerkhoturovandUmputun a6a9270f63 apply pngcrush, advpng and optipng to all png images
Commands used:

```
find . -type f -iname "*.png" -exec advpng -z4 {} \;
find . -type f -iname "*.png" -exec optipng -o7 -preserve {} \;
find . -type f -iname "*.png" -exec pngcrush -rem allb -brute -reduce -ow {} \;
```
2022-09-28 16:05:03 -05:00
Dmitry VerkhoturovandUmputun c0e8520d31 fix makefile and dockerfile
Here are multiple changes to commands run by Makefile based on my
attempts to run it on an Oracle Linux machine with the latest Docker.
2022-09-17 13:05:56 -05:00
Dmitry Verkhoturov 9ad3be2e97 bump go modules, make auth dev hostname customisable
After this commit, dev auth would start working with the `REMARK_URL`
hostname instead of the previously hardcoded 127.0.0.1.

Breaks development setup where `REMARK_URL` was set
to a non-standard value and dev auth was running on 127.0.0.1
and working, as, after that change, it would stop working.
2022-08-26 23:35:57 +02:00
Dmitry VerkhoturovandUmputun 28fbe76547 remove duplicated docker-compose.yml from parameters doc
Also, clarify the wording on TIME_ZONE parameter a little.
2022-08-23 22:39:02 -05:00
Dmitry VerkhoturovandUmputun 96b75af027 proper grammar for ADMIN_PASSWD parameter notes 2022-08-23 21:22:32 -05:00
Dmitry VerkhoturovandUmputun a9836aaea0 move static web files from rakyll/statik to go:embed
There is no need for the rakyll/statik package starting with Go 1.16,
which provides us with tools for embedding files
without third-party libraries.
2022-08-03 15:41:02 -05:00
Dmitry Verkhoturov 86d059bf99 move templates from rakyll/statik to go:embed
There is no need for the rakyll/statik package starting with Go 1.16,
which provides us with tools for embedding files
without third-party libraries.
2022-07-29 19:07:49 +02:00
Dmitry VerkhoturovandUmputun ac3a36eb13 rewrite email documentation, elaborate on how to replace templates
I've run Grammarly over that text to find and fix some flaws
and added more detailed instructions on replacing a built-in template
with your own.
2022-07-28 13:28:27 -05:00
Paul Mineev 86dae37c5d docs: improve frontend dev instructions 2022-07-27 10:39:10 -07:00
Paul MineevandUmputun 922e779118 docs: reorg contributing section 2022-07-25 13:23:36 -05:00
Dmitry VerkhoturovandUmputun 0aa6052eba update backup documentation
Few things here:
1. Merge automatic and manual backup to a single page
2. State that ADMIN_PASSWD must be enabled for backup or restore to work
3. Remove unneeded usage of --admin-passwd from commands
  inside the container
4. Make the main backups page (not clickable through the interface,
  available only in search) redirect to information about backups
  instead of displaying text
5. Add HTTPS port to canonical docker-compose.yml
6. Clarify build option in the canonical docker-compose.yaml
2022-07-25 12:09:42 -05:00
RobinandUmputun f25b34d5e2 docs(manuals): add ts version of react component
Some time ago Gatsby started to support Typescript natively. Also the frontend of remark42 is written in Typescript. So I thought it's a good idea to add a Typescript version of the component.
2022-07-25 12:02:08 -05:00
Paul MineevandUmputun 6625face50 update dev docs 2022-07-21 18:27:33 -05:00
Dmitry Verkhoturov 243c8356e7 do not sanitise the original comment markdown
Previously it was sanitised using the HTML sanitiser,
but it had proven troublesome and unnecessary.
Remark42 rendered the markdown into proper HTML, but then some pieces
of it (like cited HTML code inside the code block, marked by backticks)
were cut out, which then showed the incorrect markdown to a user when
they were editing the comment.

For example, the comment "`foo<bar>`" became "foo" after sanitising,
and despite the proper render user saw only "foo" when editing
the comment.

After this change, the initial comment markdown is preserved unaltered.
It could contain dangerous HTML with JS, which I assume shouldn't
be a problem as it's never rendered as HTML but instead supposed
to be converted to HTML by the interpreter. In Remark42, it's stored
in a comment.Text field and sanitised and thus safe.

I've left information about the potential danger of rendering
the original markdown as-is without an interpreter in
all relevant places I could find.
2022-07-22 01:08:08 +02:00
Paul MineevandUmputun 99716984ad up node version, add nvmrc, recommend nvm 2022-07-02 11:48:22 -05:00
Dmitry VerkhoturovandUmputun a73072c8fb add documentation on running remark42 on a separate domain 2022-06-30 19:12:00 -05:00
Paul MineevandUmputun fe4db30e6d show subscription buttons in simple view, add ability to hide rss button 2022-06-06 10:00:24 -05:00
Dmitry VerkhoturovandUmputun 9049d7a616 add missing RPC type of image storage to the documentation 2022-05-15 15:56:53 -05:00
Dmitry VerkhoturovandUmputun adb77d9a11 sync server parameters with their description 2022-05-12 11:41:52 -05:00
Dmitry VerkhoturovandUmputun a980bdbad2 switch to go-pkgz/notify package: email 2022-04-29 13:32:15 -05:00
Paul MineevandUmputun f7bddd757d Improve frontend docs 2022-04-10 11:18:15 -05:00
Dmitry VerkhoturovandUmputun 0eac76ce6c improve notifications description in parameters doc 2022-04-07 18:27:39 -05:00
Dmitry VerkhoturovandUmputun 977e5f018b renew Google auth documentation 2022-04-07 17:14:56 -05:00
Dmitry VerkhoturovandUmputun 38a680ec4c use remark42.mysite.com consistently in documentation 2022-04-07 17:14:56 -05:00
Dmitry VerkhoturovandUmputun 7af30852db add variables into auth instructions 2022-04-07 17:14:56 -05:00
Dmitry VerkhoturovandUmputun 0047fa057f add missing main component to frontend config examples 2022-04-06 18:40:27 -05:00
Dmitry VerkhoturovandUmputun 7d4ba01409 improve getting started installation instructions 2022-04-06 17:33:34 -05:00
Umputun 65e3a82d8b add no-signature mode suppressing app info middleware #1305 2022-04-05 12:08:44 -05:00
itsmejoeeeyandUmputun 86b0e8d57c Remove emoji from warning in Twitter section in auth docs 2022-03-25 23:09:39 -05:00
itsmejoeeeyandUmputun d3fe35bdf2 Add warning to Twitter section in docs Authorization page 2022-03-25 23:09:39 -05:00
Dmitry VerkhoturovandUmputun 932c0e8af0 optimise images for smaller size 2022-02-24 16:54:03 -06:00
Dmitry VerkhoturovandUmputun d47133c004 add admin UI documentation, fix title for no-subdomain doc 2022-02-24 16:54:03 -06:00
Dmitry VerkhoturovandUmputun cfb7361adf optimise images for smaller size 2022-02-24 16:18:28 -06:00
Dmitry Verkhoturov d4481d145f fix remark_config reference in the installation documentation 2022-02-23 09:12:21 +01:00
Dmitry VerkhoturovandUmputun f448208475 allow skipping frontend build in Docker
That option allows having backend-only build,
skipping the long frontend build and test step.
Frontend developers run NodeJS locally and usually
don't need to have frontend built inside the docker image.
2022-02-15 18:30:38 -06:00
konstantin krivleniaandUmputun 188e3974bc add support node 17 2022-02-13 23:33:41 -06:00
Dmitry VerkhoturovandUmputun b5f34b8777 remove notice about user notifications in telegram 2022-02-12 03:52:16 -06:00
Dmitry VerkhoturovandUmputun 9dbc36e426 remove explicit /srv/ usage from docker-compose files
We have plenty of paths used in the application, but two of them
are hardcoded in examples all over the code for historical reasons.

I found that by default in Docker, the path would resolve to the value
we are setting it explicitly to, so it doesn't make sense to set
a few variables we are setting now explicitly.
2022-02-07 03:54:54 -06:00
JoeyZhouAusandUmputun e0980d4700 Fix typo in index.md
The text in the backend development section should be backend instead of frontend
2022-02-06 21:30:01 -06:00
Dmitry VerkhoturovandUmputun f58073fa57 add proper default values for two boolean variables 2022-02-06 16:37:47 -06:00
Dmitry VerkhoturovandUmputun 49d2552a78 fix frontend documentation typo 2022-02-06 13:55:52 -06:00
RoganikandUmputun 78be64900b Add tips to url-migration docs 2022-02-06 12:42:32 -06:00
Dmitry VerkhoturovandUmputun 3a9806a368 improve doc on backend run without docker 2022-01-30 19:05:57 -06:00
Dmitry VerkhoturovandUmputun ffa0d34ed1 improve backend and frontend development docs
Remove generic development documentation, make frontend
and backend pages more specific and self-sufficient,
as previously you had to read development and frontend
pages in order to understand how to properly develop
frontend.
2022-01-30 12:25:07 -06:00
Umputun dc9411e2b9 add work-in-progress note about tg auth docs 2022-01-30 04:09:45 -06:00