Skip to content

README: added info about Debian package #11

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

Closed
wants to merge 1 commit into from
Closed

README: added info about Debian package #11

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
8 changes: 8 additions & 0 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,8 @@ It is recommended to use the latest [ngx_openresty bundle](http://openresty.org)
is bundled and enabled by default. At least ngx_openresty 1.4.2.9 is required. And you need to enable LuaJIT when building your ngx_openresty
bundle by passing the `--with-luajit` option to its `./configure` script. No extra Nginx configuration is required.

It is also available as Debian package [lua-nginx-websocket](https://tracker.debian.org/pkg/lua-nginx-websocket).

If you want to use this library with your own Nginx build (with ngx_lua), then
you need to ensure you are using at least ngx_lua 0.9.0
(and [lua-bitop](http://bitop.luajit.org/) library if you are not using LuaJIT).
Expand All @@ -568,6 +570,12 @@ and then load the library in Lua:
local server = require "resty.websocket.server"
```

if you are using Debian package:

```lua
local server = require "nginx.websocket.server"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I hate the way the package changes the Lua module name, which is breaking API compatibility.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can understand that, I fellow the naming from Debian. Thank for you feedback.

```

[Back to TOC](#table-of-contents)

TODO
Expand Down