Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added some details re: prerequisites, installation, embedding etc. #38

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Added some details re: prerequisites, installation, embedding etc. #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,14 @@ files edited in CryptPad.

## Installation

You can install this app in one of the following ways: either from the NextCloud app store, from a binary release, or by cloning this repository. Once installed, you can check CryptPad is configured correctly by checking that the url listed under Administration > CryptPad is the same as the url of your local CryptPad instance.

### Prerequisites on the CryptPad side

To embed CryptPad into Nextcloud, the "Enable remote embedding" admin setting
needs to be enabled. You can find this setting on the "Administration" web
interface in the "General" tab.
interface in the "Security" tab.


### Install from Nextcloud app store

Expand Down Expand Up @@ -81,15 +84,15 @@ interface in the "General" tab.
}
```

### Verify binary release
#### Verify binary release

To verify the binary release you run the following command:

``` shell
openssl dgst -sha512 -verify openincryptpad.pubkey -signature openincryptpad.tar.gz.signature openincryptpad.tar.gz
```

## Clone from repo
### Clone from repo
Place this app in **nextcloud/apps/**. Make sure the folder is named `openincryptpad`. E.g.:

``` sh
Expand All @@ -99,7 +102,12 @@ git clone https://github.com/cryptpad/nextcloud-open-in-cryptpad.git openincrypt

## Building the app

The app can be built by using the provided Makefile by running:
Prior to building, install the requisite dependencies by running:

npm ci


The app can then be built using the provided Makefile by running:

make

Expand All @@ -121,6 +129,16 @@ The make command will install or update Composer dependencies if a composer.json
}
```

## Running the Nextcloud server

Before running Nextcloud, ensure you have an up-to-date version of PHP installed in the `nextcloud` repository, and run the following commands:

git switch v29.0.7 --detach
git submodule update --init

Then, to run the server:

php -S localhost:8080

## Publish to App Store

Expand Down
Loading